Thank you for your interest in contributing to Octicons! We currently are only accepting submissions from GitHub staff and only include icons that are used in the GitHub UI.
If you plan to update an icon and/or add a new icon follow these steps. These steps will be the same for core primer members and contributors.
Complete steps 1 - 3 and notify us of your changes, either with a pull request or an issue describing your changes. Screenshots welcome! 🎉
The first step is to make a copy of the master Octicons file to your drafts folder. You can do this from the dropdown menu, select "Duplicate to your drafts".
In your duplicate file, make proposed changes. In the example, we’ll make the GitHub logo red. It will also simplify things if you give your file a unique name e.g. Octicons (Jon’s Changes).
Make sure your duplicate file can be viewed by others. In the share menu "Anyone with link" should be set to "can view". Copy the link.
Create a new issue using the Octicon submission template. Fill out the issue with screenshots of the icon(s), a link to the figma document, and remaining information.
The design systems team will review the submission and request any changes. If approved, your icon will be added to the next octicons release.
Once submitted changes have been agreed upon, these instructions will guide core primer team members in merging in those changes.
If the icon is being updated, you'll need to keep the existing component and copy the new path into it.
Any separate shapes under the icon component need to be unioned into one path. This is for performance when serving the icons.
If the icon is not already a component you must create a new component. To do so, click the Create Component button in the top toolbar inside of Figma to add the icon as a component of the Octicons library.
If the icon is already a component, make sure you are updating the contents of the related component.
Each icon needs keywords to help build out the icon search. Add keywords: foo, bar to the "Component" section in the figma toolbar.
Once all of the changes have been made to the Octicons file, be sure to publish the changes to the component library.
After you've published the latest changes in the Figma file, create a release branch in the Octicons repo.
Update the CHANGELOG with the new changes pertaining to this version.
Once the CHANGELOG has been updated, run npm version <newversion>. This will update package.json with the new version, then update all the lib/* packages with the same version. If that runs smoothly, it should commit the changed files. Push that commit to your release branch.
In the context of Octicons, significant changes to the library or workflow, or removing an icon would be considered a major update, adding a new icon would be considered a minor update, and fixing an icon would be considered a patch. Reach out in the #design-systems Slack channel if you're unsure!
After, push up your branch and open a pull request into master.