Skip to content

Commit 8e3775c

Browse files
authored
Merge pull request #280 from primer/contribution-guidelines
Update contributor guidelines
2 parents 9e3ee30 + d4185e9 commit 8e3775c

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

.github/CONTRIBUTING.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,26 +49,33 @@ Example:
4949
5050
## Feature requests
5151

52-
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
52+
Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
5353

5454
## Pull requests
5555

5656
Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
5757

5858
**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.
5959

60-
Adhering to the following process is the best way to get your work included in the project:
60+
### Updating Primer modules
6161

62-
1. Fork and clone the repository
63-
2. Configure and install the dependencies: `bower install`
64-
3. Create a new branch: `git checkout -b my-branch-name`
65-
4. Make your change, add tests, and make sure the tests still pass
66-
5. Push to your fork and [submit a pull request][pr]
67-
6. Pat your self on the back and wait for your pull request to be reviewed and merged.
62+
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.
63+
64+
1. Fork and clone [this repository](https://github.com/primer/primer-css).
65+
2. Configure and install the dependencies: `npm install`
66+
3. Check out the dev branch `git checkout dev`
67+
3. Create a new branch from dev `git checkout -b my-branch-name`
68+
4. Make your changes and commit them.
69+
5. Push your branch and open a pull request against `dev`. Add a comment describing your proposed changes and request a review from `@primer/ds-core`.
70+
6. Wait for CI tests to finish.
71+
- 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.
72+
- If the tests fail, review the logs and address any issues.
73+
- If the builds fail for any other reason (as they occasionally do), they may need to be manually restarted.
74+
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.
75+
8. Pat yourself on the back and wait for your pull request to be reviewed.
6876

6977
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
7078

71-
- Follow the [style guide][style].
7279
- 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.
7380
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
7481

0 commit comments

Comments
 (0)