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.
You can submit a pull request updating the FIGMA_FILE_URL configuration in the .github/workflows/push.yml with your Figma file. Doing so will generate alpha releases of all the libraries that distribute Octicons.
If an icon was edited or added, you should see the before and after images directly in the PR. In addition, please describe your proposed changes in the PR's description.
Once the build passes on your pull request, you should see statuses with all the alpha versions of the libraries. You can then use these to test your changes.
Here is an example pull request
Once submitted changes have been agreed upon, these instructions will guide core primer team members in merging in those changes.
Save the contributor’s Figma file as a .fig file and open in Figma (it will automatically be imported into your Drafts)
Drag and drop, or paste the updated or new icon from the contributer's file into the main Octicons Figma file. Make sure that the SVG only contains a single path and that it has relevant component keywords in Figma.
Once the new changes have been added the new components to the master Octicons file, you can publish to the team library in Figma.
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.