Skip to content

Commit

Permalink
Update octicons docs
Browse files Browse the repository at this point in the history
Updates to the process
  • Loading branch information
tallys committed Nov 16, 2022
1 parent 3f6d002 commit c1e4350
Showing 1 changed file with 11 additions and 18 deletions.
29 changes: 11 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,26 @@ Thank you for your interest in contributing to Octicons! We are currently only a

## Icon request process

### 1. Icon request is made
### 1. Icon review request is made

- 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).
- 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)
- 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)
- 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).
- 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.

### 2. Assigning icons
### 2. Working on icons

- Each new icon request will initially be discussed async within our #octicons channel on Slack.
- 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)
- 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)
- 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)
- Icon requests will be assigned to a designer in the weekly Octicons sync held on Wednesdays
- Once an icon has been assigned, it's up to assigned designer to be responsible for communicating the icon's status
- Other designers are welcome to collaborate on any icons
- If an icon recommendation can be made async, we will discuss it in #primer-octicons or directly in the issue.
- Icon review requests require a working session, we will send an invitation.
- 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.

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

- 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)
- 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.
- 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
- 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)
- All review communication will be contained within the PR
- PRs need approval from the icon requestor (stakeholder) and at least one designer on the octicons maintainer team
- 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.

### 4. Icon request completed
- 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)
- After a new release has been made, the new icons that were added will have their request issues moved to the **Done** column
- When an icon request PR has been approved, communicate that in the issue.
- After the Octicons release, the new icons that were added will have their request issues moved to the **Done** column


## Adding or updating an icon
Expand Down

0 comments on commit c1e4350

Please sign in to comment.