primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-11-24 13:15:00 +03:00
Code Issues Projects Releases Wiki Activity

update contributor guidelines for module updates

Browse Source
This commit is contained in:
Diana Mounter 2017-07-25 15:41:45 -07:00 committed by GitHub
parent 9fb107dcca
commit b99e914568
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
.github/CONTRIBUTING.md vendored
View File

@ -57,18 +57,22 @@ Good pull requests—patches, improvements, new features—are a fantastic help.
**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
Adhering to the following process is the best way to get your work included in the project:
## Updating Primer modules
1. Fork and clone the repository
Anyone can open a pull request on Primer CSS. You do not need to work at GitHub or be a member of the org to open a pull request.
1. Fork and clone the primer/primer-css repository.
2. Configure and install the dependencies: `npm install`
3. Create a new branch: `git checkout -b my-branch-name`
4. Make your change, add tests, and make sure the tests still pass
5. Push to your fork and [submit a pull request][pr]
6. Pat your self on the back and wait for your pull request to be reviewed and merged.
3. Check out the dev branch `git checkout dev`
3. Create a new branch from dev `git checkout -b my-branch-name`
4. Make your changes, add and commit them.
5. Push your branch and open a pull request, request a review from @primer/ds-core
6. Wait for CI tests to pass, if they do not, fix the errors or ask for help from @primer/ds-core.
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.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow the [style guide][style].
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).