Skip to content

Commit c1e4350

Browse files
authored
Update octicons docs
Updates to the process
1 parent 3f6d002 commit c1e4350

1 file changed

Lines changed: 11 additions & 18 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,26 @@ Thank you for your interest in contributing to Octicons! We are currently only a
44

55
## Icon request process
66

7-
### 1. Icon request is made
7+
### 1. Icon review request is made
88

9-
- Icon requests are made using the [icon request template](https://github.com/github/primer/issues/new?assignees=ashygee&labels=octicon%2C+request&template=2-icon-request.md&title=%5BIcon+request%5D+) in the github/primer repo (visible to GitHub staff only).
10-
- Once received, the issue will be placed in the **❓ Icon requests (inbox)** column of the [Octicons project board](https://github.com/orgs/github/projects/4503/views/11)
11-
- Icons in the inbox will be triaged by a maintainer from the Octicons team. Maintainers should reply with a comment on the issue and then move the issue to the **💬 Responded** column of the Octicons [project board](https://github.com/orgs/github/projects/4503/views/11)
9+
- Icon review requests are made using the [icon request template](https://github.com/github/primer/issues/new?assignees=&labels=octicon%2C+request%2C+needs+triage&template=02-icon-request.md&title=%5BIcon+request%5D+) in the github/primer repo (visible to GitHub staff only).
10+
- Icons in the Primer Roadmap inbox will be triaged by a maintainer from the Octicons team. Maintainers should reply with a comment on the issue and then move the issue to Primer Teams Backlog.
1211

13-
### 2. Assigning icons
12+
### 2. Working on icons
1413

15-
- Each new icon request will initially be discussed async within our #octicons channel on Slack.
16-
- If the icon requires further discussion or needs more context before assigning, a maintainer will leave a comment on the issue requesting more information from the original requestor and the issue will be moved to the **⚠️ To discuss** column of the Octicons [project board](https://github.com/orgs/github/projects/4503/views/11)
17-
- If a currently existing icon can be used to clearly convey the correct metaphor, a suggestion will be made in the icon request issue and the issue will be moved to the **⚠️ To discuss** column of the Octicons [project board](https://github.com/orgs/github/projects/4503/views/11)
18-
- If it is decided that a new icon needs to be created the issue will be moved to the **📫 To do** column of the Octicons [project board](https://github.com/orgs/github/projects/4503/views/11)
19-
- Icon requests will be assigned to a designer in the weekly Octicons sync held on Wednesdays
20-
- Once an icon has been assigned, it's up to assigned designer to be responsible for communicating the icon's status
21-
- Other designers are welcome to collaborate on any icons
14+
- If an icon recommendation can be made async, we will discuss it in #primer-octicons or directly in the issue.
15+
- Icon review requests require a working session, we will send an invitation.
16+
- Once an icon has been assigned, it's up to assigned designer to be responsible for communicating the icon's status and drive the work forward.
2217

2318
### 3. Icon design, review, and communication
2419

25-
- Once design has been started on an icon, the request issue will be moved to the **✒️In Progress** column of the Octicons [project board](https://github.com/orgs/github/projects/4503/views/11)
20+
- Once design has been started on an icon, the request issue will be moved to the **Design in Progress** column of the Primer Teams Backlog.
2621
- Designers should design the icon in Figma and when ready for review, use the [Octicons Push plugin](https://www.figma.com/community/plugin/825432045044458754/Octicons-Push) to create a PR
27-
- After a PR is created link to the PR in the icon request issue and move the issue to the **👁‍🗨 Ready for review** column of the Octicons [project board](https://github.com/orgs/github/projects/4503/views/11)
28-
- All review communication will be contained within the PR
29-
- PRs need approval from the icon requestor (stakeholder) and at least one designer on the octicons maintainer team
22+
- After a PR is created link to the PR in the icon request issue. PRs need approval from the icon requestor (stakeholder) and at least one designer on the octicons maintainer team.
3023

3124
### 4. Icon request completed
32-
- When an icon request PR has been approved by both the requestor and a member of Octicons maintainer team, the icon request is moved to the **🔼 Push to repo** column of the Octicons [project board](https://github.com/github/primer/projects/2)
33-
- After a new release has been made, the new icons that were added will have their request issues moved to the **Done** column
25+
- When an icon request PR has been approved, communicate that in the issue.
26+
- After the Octicons release, the new icons that were added will have their request issues moved to the **Done** column
3427

3528

3629
## Adding or updating an icon

0 commit comments

Comments
 (0)