From a029d04b586279d4327627d9ee50e04a19e0ad35 Mon Sep 17 00:00:00 2001 From: rox <120587372+roxanagomez@users.noreply.github.com> Date: Tue, 21 May 2024 09:54:45 -0500 Subject: [PATCH 1/5] feat: Create icon-requests.md --- internal-docs/process/icon-requests.md | 32 ++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 internal-docs/process/icon-requests.md diff --git a/internal-docs/process/icon-requests.md b/internal-docs/process/icon-requests.md new file mode 100644 index 0000000000..8c8090d0bf --- /dev/null +++ b/internal-docs/process/icon-requests.md @@ -0,0 +1,32 @@ +# New Icon Request +There is a new icon request on GitHub. As the helper, here's what you should do. +Read the request and review the needed icon(s). +Ensure the requested icon is suitable to be part of Paste library: +It doesn’t already exist +If it exists, you can suggest using the current one or ask to explain why a different one is needed +It is not too similar to an existing one or it doesn’t convey the concept in a optimal way +If it's too similar, you can propose other options using streamline (send your proposal to the discussion) +It is a general concept that can easily be used by other teams (i.e. a shopping cart) +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 the broader team if necessary) +If the icon is suitable, ask the requester to file a dependency in Aritable. +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 here +Create a Jira ticket with the next release date 'Figma: Icons for YYYY.MM.DD release' for designers to work on the task. +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 +If you're a helper 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 NPMJS.com - 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. +Icon Request Design +If 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. +When ready, send your branch for review to #plz-design-systems. +When approved, export each icon individually following Paste Docs instructions. +Attach the SVGs (individually) to the engineer's Jira ticket. + +That’s all—hooray! From 87569aa541248c3e6a87e9e69954b174b6e843ce Mon Sep 17 00:00:00 2001 From: rox <120587372+roxanagomez@users.noreply.github.com> Date: Tue, 21 May 2024 16:29:02 -0500 Subject: [PATCH 2/5] Update icon-requests.md --- internal-docs/process/icon-requests.md | 66 ++++++++++++++------------ 1 file changed, 35 insertions(+), 31 deletions(-) diff --git a/internal-docs/process/icon-requests.md b/internal-docs/process/icon-requests.md index 8c8090d0bf..fe052e54f4 100644 --- a/internal-docs/process/icon-requests.md +++ b/internal-docs/process/icon-requests.md @@ -1,32 +1,36 @@ -# New Icon Request -There is a new icon request on GitHub. As the helper, here's what you should do. -Read the request and review the needed icon(s). -Ensure the requested icon is suitable to be part of Paste library: -It doesn’t already exist -If it exists, you can suggest using the current one or ask to explain why a different one is needed -It is not too similar to an existing one or it doesn’t convey the concept in a optimal way -If it's too similar, you can propose other options using streamline (send your proposal to the discussion) -It is a general concept that can easily be used by other teams (i.e. a shopping cart) -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 the broader team if necessary) -If the icon is suitable, ask the requester to file a dependency in Aritable. -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 here -Create a Jira ticket with the next release date 'Figma: Icons for YYYY.MM.DD release' for designers to work on the task. -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 -If you're a helper 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 NPMJS.com - 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. -Icon Request Design -If 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. -When ready, send your branch for review to #plz-design-systems. -When approved, export each icon individually following Paste Docs instructions. -Attach the SVGs (individually) to the engineer's Jira ticket. +## 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: + * 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 and sharing 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 sharing 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) +* If the icon is 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 here](https://paste.twilio.design/roadmap)** + +* Create a Jira ticket with the next release date 'Figma: Icons for YYYY.MM.DD release' for designers to work on the task. +* 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 NPMJS.com - 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. -That’s all—hooray! From 84fdb73e6bb8fa3b4152cbe92842044061d5a0ac Mon Sep 17 00:00:00 2001 From: rox <120587372+roxanagomez@users.noreply.github.com> Date: Tue, 21 May 2024 16:32:18 -0500 Subject: [PATCH 3/5] Update icon-requests.md --- internal-docs/process/icon-requests.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal-docs/process/icon-requests.md b/internal-docs/process/icon-requests.md index fe052e54f4..d1d793b9ba 100644 --- a/internal-docs/process/icon-requests.md +++ b/internal-docs/process/icon-requests.md @@ -13,9 +13,9 @@ You're in helper duty and there is a new icon request on GitHub: * If the icon is 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 here](https://paste.twilio.design/roadmap)** +**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 designers to work on the task. +* 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. From 9883158bd2d2ec4c18e9005fef4ed8738f1b2e94 Mon Sep 17 00:00:00 2001 From: rox <120587372+roxanagomez@users.noreply.github.com> Date: Thu, 23 May 2024 08:37:56 -0500 Subject: [PATCH 4/5] Update internal-docs/process/icon-requests.md Co-authored-by: Sarah --- internal-docs/process/icon-requests.md | 1 + 1 file changed, 1 insertion(+) diff --git a/internal-docs/process/icon-requests.md b/internal-docs/process/icon-requests.md index d1d793b9ba..19c9391b4f 100644 --- a/internal-docs/process/icon-requests.md +++ b/internal-docs/process/icon-requests.md @@ -2,6 +2,7 @@ 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 and sharing it in the Github discussion. From b5e701d145bd106e8a996185cf1f414bc6d3cc08 Mon Sep 17 00:00:00 2001 From: rox <120587372+roxanagomez@users.noreply.github.com> Date: Thu, 23 May 2024 08:40:41 -0500 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: Sarah --- internal-docs/process/icon-requests.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/internal-docs/process/icon-requests.md b/internal-docs/process/icon-requests.md index 19c9391b4f..db3b0ef92b 100644 --- a/internal-docs/process/icon-requests.md +++ b/internal-docs/process/icon-requests.md @@ -5,13 +5,14 @@ You're in helper duty and there is a new icon request on GitHub: * 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 and sharing it in the Github discussion. + * 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 sharing it in the Github discussion. + * 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) -* If the icon is suitable, ask the requester to file a dependency using this [Airtable link](https://airtable.com/appwvsQKyJHfnG5Sa/shrvMvL3BG6Zm0f9l) +* 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)** @@ -23,8 +24,8 @@ You're in helper duty and there is a new icon request on GitHub: ## 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 NPMJS.com - https://www.npmjs.com/package/@twilio-paste/icons?activeTab=versions + * 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