From d4d6eaac0a50ee051e741dd07a6424b88de36484 Mon Sep 17 00:00:00 2001 From: Josh Black Date: Tue, 16 Jun 2020 18:13:05 -0500 Subject: [PATCH 1/3] Update developer-handbook.md --- docs/developer-handbook.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/developer-handbook.md b/docs/developer-handbook.md index 04912c7d454b..3ae14be825ec 100644 --- a/docs/developer-handbook.md +++ b/docs/developer-handbook.md @@ -627,6 +627,32 @@ You don't need to do anything in `carbon-components` side. ## Maintainers +### Working with icons and pictograms + +We get work submitted by the IBM Brand team, along with other designers at IBM, that contributes new or updated assets to our icons or pictograms packages. When you are requested to review these Pull Requests, here are some common things to look for: + +1. Do the assets follow a param-case naming convention? + +If not, we'll need to request changes so that they are named using the `param-case` convention. + +2. Is the CI check failing because of missing metadata? + +If so, you will need to help out the contributor by going into the package and running `node tasks/scaffold.js` to seed the metadata information required for the contribution. + +_Note: the scaffold task will only apply to the main metadata file, for new icons category information will have to be added by hand_ + +3. Is the CI check failing because of a merge conflict? + +If so, you will need to help out the contributor by resolving the merge conflicts for the Pull Request. + +4. Is the CI check failing because of a snapshot change? + +If so, you will need to help out the contributor by updating the snapshot based on the changes. + +5. Does the Pull Request have an appropriate title? + +If not, then you will need to update it to the correct commit convention for the contribution. + ### Code Patterns #### Deprecating a component From 1a5d912aabd5418f4f8f24b5286c691158fc107e Mon Sep 17 00:00:00 2001 From: Josh Black Date: Fri, 19 Jun 2020 10:59:45 -0500 Subject: [PATCH 2/3] docs(handbook): add commands for snapshot changes --- docs/developer-handbook.md | 39 +++++++++++++++++++++++++++++++------- 1 file changed, 32 insertions(+), 7 deletions(-) diff --git a/docs/developer-handbook.md b/docs/developer-handbook.md index 3ae14be825ec..6f244b3e62ee 100644 --- a/docs/developer-handbook.md +++ b/docs/developer-handbook.md @@ -629,29 +629,54 @@ You don't need to do anything in `carbon-components` side. ### Working with icons and pictograms -We get work submitted by the IBM Brand team, along with other designers at IBM, that contributes new or updated assets to our icons or pictograms packages. When you are requested to review these Pull Requests, here are some common things to look for: +We get work submitted by the IBM Brand team, along with other designers at IBM, +that contributes new or updated assets to our icons or pictograms packages. When +you are requested to review these Pull Requests, here are some common things to +look for: 1. Do the assets follow a param-case naming convention? -If not, we'll need to request changes so that they are named using the `param-case` convention. +If not, we'll need to request changes so that they are named using the +`param-case` convention. 2. Is the CI check failing because of missing metadata? -If so, you will need to help out the contributor by going into the package and running `node tasks/scaffold.js` to seed the metadata information required for the contribution. +If so, you will need to help out the contributor by going into the package and +running `node tasks/scaffold.js` to seed the metadata information required for +the contribution. -_Note: the scaffold task will only apply to the main metadata file, for new icons category information will have to be added by hand_ +_Note: the scaffold task will only apply to the main metadata file, for new +icons category information will have to be added by hand_ 3. Is the CI check failing because of a merge conflict? -If so, you will need to help out the contributor by resolving the merge conflicts for the Pull Request. +If so, you will need to help out the contributor by resolving the merge +conflicts for the Pull Request. 4. Is the CI check failing because of a snapshot change? -If so, you will need to help out the contributor by updating the snapshot based on the changes. +If so, you will need to help out the contributor by updating the snapshot based +on the changes. To update snapshot, you'll need to rebuild the relevant packages +and then run Jest. + +For example, if icons changed you will want to run the following commands: + +```bash +yarn lerna run build --scope='@carbon/icons-react' --include-dependencies +yarn test:e2e -u +``` + +If pictograms changed, it would be: + +```bash +yarn lerna run build --scope='@carbon/pictograms-react' --include-dependencies +yarn test:e2e -u +``` 5. Does the Pull Request have an appropriate title? -If not, then you will need to update it to the correct commit convention for the contribution. +If not, then you will need to update it to the correct commit convention for the +contribution. ### Code Patterns From 64487549d9d58f683e51943e29199d9ace0246cc Mon Sep 17 00:00:00 2001 From: Josh Black Date: Mon, 22 Jun 2020 15:09:14 -0500 Subject: [PATCH 3/3] docs(handbook): add breaking change notes for icons --- docs/developer-handbook.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/developer-handbook.md b/docs/developer-handbook.md index 6f244b3e62ee..dd1c722ed191 100644 --- a/docs/developer-handbook.md +++ b/docs/developer-handbook.md @@ -33,6 +33,7 @@ - [Using `npm link`/`yarn link`](#using-npm-linkyarn-link) - [Pointing NPM dependency of `carbon-components` right to the source code](#pointing-npm-dependency-of-carbon-components-right-to-the-source-code) - [Maintainers](#maintainers) + - [Working with icons and pictograms](#working-with-icons-and-pictograms) - [Code Patterns](#code-patterns) - [Deprecating a component](#deprecating-a-component) - [Publishing](#publishing) @@ -678,6 +679,14 @@ yarn test:e2e -u If not, then you will need to update it to the correct commit convention for the contribution. +6. Does the Pull Request remove an asset that used to exist? + +If so, remind the contributor that we can only remove assets in a major release. +If an asset needs to be removed, they should add the asset back in under its +original name and add it to the corresponding `deprecated.yml` file. They can +still contribute the newly named asset, and it is recommended that they specify +the replacement for the icon in `deprecated.yml` under the `reason` field. + ### Code Patterns #### Deprecating a component