You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,27 @@ If you'd like to contribute to Pattern Lab Node, please do so! There is always a
5
5
6
6
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.
7
7
8
+
## Developing Locally
9
+
10
+
The best way to make changes to the Pattern Lab Node core and test them is through your existing edition.
11
+
12
+
* Fork this repository on Github.
13
+
* Create a new branch in your fork and push your changes in that fork.
14
+
*`npm install`
15
+
*`npm link`
16
+
*`cd /path/to/your/edition`
17
+
*`npm link patternlab-node`
18
+
19
+
8
20
Guidelines
9
21
----------
10
22
11
-
1. Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier.
12
-
2. *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`
13
-
3. If you can, add some unit tests using the existing patterns in the `./test` directory
14
-
4. Please mention the issue number in commits if you can, so anyone can see to which issue your changes belong to. For instance:
23
+
*_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`
24
+
* Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier.
25
+
* Commits should reference the issue you are adressing. For any Pull Request that you send, use the template provided.
26
+
* If you can, add some unit tests using the existing patterns in the `./test` directory
27
+
* 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.
28
+
* Please mention the issue number in commits if you can, so anyone can see to which issue your changes belong to. For instance:
0 commit comments