Skip to content

Commit 89953c8

Browse files
authored
Update CONTRIBUTING.md
Porting Octicon contribution guidelines from Primer docs
1 parent 0f2a2ff commit 89953c8

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ Thank you for your interest in contributing to Octicons! We are currently only a
3030

3131
Follow these steps to add or update an icon.
3232

33-
### 1. Clone the repository
33+
### Manually with SVG files
34+
35+
#### 1. Clone the repository
3436

3537
```shell
3638
# Clone the repository
@@ -53,15 +55,15 @@ cd octicons
5355
git remote add upstream https://github.com/primer/octicons
5456
```
5557

56-
### 2. Create a new feature branch
58+
#### 2. Create a new feature branch
5759

5860
```shell
5961
git checkout -b <branch-name>
6062
```
6163

62-
### 3. Add or update SVG files in the `/icons` directory
64+
#### 3. Add or update SVG files in the `/icons` directory
6365

64-
### 4. Add or update keywords in `keywords.json`
66+
#### 4. Add or update keywords in `keywords.json`
6567

6668
```diff
6769
{
@@ -70,20 +72,45 @@ git checkout -b <branch-name>
7072
}
7173
```
7274

73-
### 5. Commit and push changes
75+
#### 5. Commit and push changes
7476

7577
```shell
7678
git add .
7779
git commit -m <message>
7880
git push
7981
```
8082

81-
### 6. Create a pull request
83+
#### 6. Create a pull request
8284

8385
Use GitHub to [create a pull request](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request) for your branch. In your pull request description, be sure to mention where the icon will be used and any relevant timeline information.
8486

8587
If everything looks good, a maintainer will approve and merge the pull request when appropriate. After the pull request is merged, your icon will be available in the next Octicons release.
8688

89+
### Using the Octicons Push Figma plugin
90+
91+
If you work at GitHub, you can use the [Octicons Push](https://www.figma.com/community/plugin/825432045044458754/Octicons-Push) Figma plugin to start an Octicons pull request from Figma.
92+
93+
Here's how it works:
94+
95+
1. Select the icon frames you want to commit. Make sure the frames are either 16x16 or 24x24 and that you've outlined all strokes.
96+
2. Open the Octicons Push plugin.
97+
3. Select the branch you want to commit to. You can choose an existing branch or create a new branch.
98+
4. Press "Commit." The plugin will then export, commit, and push the selected icons to the branch you chose. If you chose to create a new branch, the plugin will give you a link to where you can start a new pull request with your branch.
99+
100+
After you create a pull request, a member of the Design Infrastructure team will triage and review your contribution.
101+
102+
![demo showing how to create a pull request using the Octicons Push Figma plugin](https://user-images.githubusercontent.com/4608155/77948730-b1a24600-727a-11ea-9c39-040be9a12963.gif)
103+
104+
## How changes are reviewed
105+
106+
Here are a few questions we'll ask when reviewing new octicons. Keep these in mind as you're designing:
107+
108+
- Where will this icon be used in the context of GitHub UI?
109+
- Is an icon necessary in that context?
110+
- Could we use an existing icon?
111+
- Is the icon trying to represent too many ideas?
112+
- Does it follow the design guidelines?
113+
87114
## Releasing changes
88115

89116
Once submitted changes have been agreed upon, these instructions will guide maintainers through releasing changes.

0 commit comments

Comments
 (0)