Skip to content

feat: Create icon-requests.md #3916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions internal-docs/process/icon-requests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## New Icon Request
You're in helper duty and there is a new icon request on GitHub:
* Read the request and review the needed icon(s).
* Make sure the requested icon is suitable to be part of Paste library:
* If the requester is external to Twilio, determine whether the icon is generic enough to be used by other teams at Twilio. If it's not generic, you can point them to the [SVG-to-React library](https://paste.twilio.design/core/libraries), which allows them to create a React component with their SVG.
* It doesn’t already exist or is too similar to an existing one
* If it exists, you can suggest using the current one or ask to explain why a different one is needed.
* If it's too similar, you can propose other options using [Streamline](https://www.streamlinehq.com/icons/legacy-streamline-regular) and share it in the Github discussion.
* It conveys the concept in a clear way
* If it doesn't convey the concept, you can propose other options using Streamline and share it in the Github discussion.
* It is a general concept that can easily be used by other teams
* If it's not clear to you, directly ask the requester if the icon will be used by other teams.
* If the icon is...
* **Not suitable**, ask the requester to add it to their local libraries (confirm with Paste Design team if necessary)
* **Suitable**, ask the requester to file a dependency using this [Airtable link](https://airtable.com/appwvsQKyJHfnG5Sa/shrvMvL3BG6Zm0f9l)
* Once the dependency is submitted, mark the GitHub ticket as 'Fix/change in progress'.

**Keep in mind that icons are batched together in the last sprint of each release. [Check release dates](https://paste.twilio.design/roadmap)**

* Create a Jira ticket with the next release date 'Figma: Icons for YYYY.MM.DD release' for the design ticket.
* Include the list of icons names to be included in the release along with their links to the GitHub discussion.
* Clone the Jira ticket and name it 'Add icons for 2024.05.14 release' for the engineering ticket.

## Update Icon Requests
You're in helper duty and there are open/unanswered icon request discussions:
* Check if the requested icons have been released and are ready to use:
* You can check the [CHANGELOG in the repository](https://github.com/twilio-labs/paste/blob/main/packages/paste-icons/CHANGELOG.md)
* You can check the [last icon package deploy on NPM](https://www.npmjs.com/package/@twilio-paste/icons?activeTab=versions)
* Update the requester with the status only if the icons are released and ready to use, and provide the link to the PR and Figma.

## Design New Icon Request
You’re assigned an icon design ticket:
* Review the list of icons in the ticket and their discussions.
* Follow the Paste Docs instructions to [add a new icon to Figma](https://paste.twilio.design/introduction/contributing/icons#setting-up-an-icon-in-figma).
* When ready, send your branch for review to #plz-design-systems.
* When approved, Follow the Paste Docs instructions to [export each icon individually](https://paste.twilio.design/introduction/contributing/icons#exporting-the-icon).
* Attach the SVGs to the engineer's Jira ticket.

Loading