|
1 |
| -# Contributing to Patternlab Node |
| 1 | +# Contributing to Pattern Lab Node |
2 | 2 | If you'd like to contribute to Pattern Lab Node, please do so! There is always a lot of ground to cover and something for your wheelhouse.
|
3 | 3 |
|
4 | 4 | No pull request is too small. Check out any [up for grabs issues](https://github.com/pattern-lab/patternlab-node/labels/up%20for%20grabs) as a good way to get your feet wet, or add some more unit tests.
|
5 | 5 |
|
6 |
| -## Guidelines |
7 |
| -* Fork the repo on Github and install the developer version using Git. |
| 6 | +## Developing Locally |
| 7 | + |
| 8 | +The best way to make changes to the Pattern Lab Node core and test them is through your existing edition. |
| 9 | + |
| 10 | +* Fork this repository on Github. |
8 | 11 | * Create a new branch in your fork and push your changes in that fork.
|
9 |
| -* _ALWAYS_ submit pull requests against the [dev branch](https://github.com/pattern-lab/patternlab-node/tree/dev). If this does not occur, I will first, try to redirect you gently, second, port over your contribution manually if time allows, and/or third, close your pull request. If you have a major feature to stabilize over time, talk to @bmuenzenmeyer about making a dedicated `feature-branch` |
| 12 | +* `npm install` |
| 13 | +* `npm link` |
| 14 | +* `cd /path/to/your/edition` |
| 15 | +* `npm link patternlab-node` |
| 16 | + |
| 17 | +## Guidelines |
| 18 | + |
| 19 | +* _ALWAYS_ submit pull requests against the [dev branch](https://github.com/pattern-lab/patternlab-node/tree/dev). If this does not occur, I will first, try to redirect you gently, second, port over your contribution manually if time allows, and/or third, close your pull request. If you have a major feature to stabilize over time, talk to @bmuenzenmeyer via an issue about making a dedicated `feature-branch` |
10 | 20 | * Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier.
|
11 |
| -* Whatever commits you make in the project through a pull request , it should reference the issue you are adressing. For any Pull Request that you send, you should mention the issues which you are working for. This makes a lot more easier to review the PR. |
| 21 | +* Commits should reference the issue you are adressing. For any Pull Request that you send, use the template provided. |
12 | 22 | * If you can, add some unit tests using the existing patterns in the `./test` directory
|
13 |
| -* If you are working on a large enhancement that might include multiple file changes, please make sure that you first open an issue adressing what enhancements you want to include and then open the Pull Request. This will result in a more systematic way for us to review your contribution also. |
| 23 | +* Large enhancements should begin with opening an issue. This will result in a more systematic way for us to review your contribution and determine if a [specifcation discussion](https://github.com/pattern-lab/the-spec/issues) needs to occur. |
14 | 24 |
|
15 | 25 | ## Coding style
|
16 | 26 | Two files combine within the project to define and maintain our coding style.
|
|
0 commit comments