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.url configuration in the root package.json with your figma file. Doing so will generate alpha releases of all the libraries that distribute Octicons.
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.
Drag and drop, or add the file to the main team project. Make sure its name is different from the master Octicons file.
From the new imported file, publish the updated or new components to the team library. This published component makes importing into the master document easier.
In the Team Library you will see the new Octicons file, and all the components from that file. Add the new components to the master Octicons file. It makes changing easier if you drag it on top of the icon you are changing.
Right click on the new component instance and select "Detach Instance". Then toggle both the old and new components open. Move the shape from the new component into the old component. Delete the old component’s shape. Delete the empty new component container.
Publish the component changes to your team library. You can now delete the imported .fig file from the contributor.
Create a release branch, and run npm run bump. This will guide you through a prompt asking what all the new versions of the packages should be. After, push up your branch and open a pull request into master.