primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-07-07 04:46:21 +03:00
Code Issues Projects Releases Wiki Activity

Update contributing docs with npx changeset step (#1987)

Browse Source 
* Add .color-bg-transparent

* Create ninety-phones-run.md

* Mention npx changeset in contributing docs

Co-authored-by: Jon Rohan <rohan@github.com>
This commit is contained in:
Sarah Vessels 2022-03-09 11:13:21 -06:00 committed by GitHub
parent 09819aa325
commit 2a05ba6744
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -58,13 +58,15 @@ Anyone can open a pull request on Primer CSS. You do not need to work at GitHub
2. Configure and install the dependencies: `npm install`
3. Create a new branch from main `git checkout -b my-branch-name`
4. Make your changes and commit them.
5. Push your branch and open a pull request. Add a comment describing your proposed changes and request a review from `@primer/css-reviewers`.
6. Wait for CI tests to finish.
5. Create a changeset for your changes: `npx changeset`
- See [changesets/changesets](https://github.com/changesets/changesets) for more information.
6. Push your branch and open a pull request. Add a comment describing your proposed changes and request a review from `@primer/css-reviewers`.
7. Wait for CI tests to finish.
- If the tests pass, you should see a status check telling you which alpha version of `@primer/css` you can install with npm to test your work in other projects.
- If the tests fail, review the logs and address any issues.
- If the builds fail for any other reason (as they occasionally do), they may need to be manually restarted.
7. When CI tests pass, a new npm alpha release will be posted under the CI checks, you can use this npm version for testing in your project or with a GitHub site if you are staff.
8. Pat yourself on the back and wait for your pull request to be reviewed.
8. When CI tests pass, a new npm alpha release will be posted under the CI checks, you can use this npm version for testing in your project or with a GitHub site if you are staff.
9. Pat yourself on the back and wait for your pull request to be reviewed.
Here are a few things you can do that will increase the likelihood of your pull request being accepted: