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
+30-23
Original file line number
Diff line number
Diff line change
@@ -5,27 +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
8
+
Developing Locally
9
+
------------------
9
10
10
11
The best way to make changes to the Pattern Lab Node core and test them is through your existing edition.
11
12
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
-
13
+
- Fork this repository on Github.
14
+
- Create a new branch in your fork and push your changes in that fork.
15
+
-`npm install`
16
+
-`npm link`
17
+
-`cd /path/to/your/edition`
18
+
-`npm link patternlab-node`
19
19
20
20
Guidelines
21
21
----------
22
22
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:
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:
29
29
- `#123 Fix resolving patterns in pattern_hunter`
30
30
- `Feature #42: improve improbability drive`
31
31
@@ -37,21 +37,28 @@ Two files combine within the project to define and maintain our coding style.
37
37
- The `.editorconfig` controls spaces / tabs within supported editors. Check out their [site](http://editorconfig.org/).
38
38
- The `.eslintrc` defines our javascript standards. Some editors will evaluate this real-time - otherwise it's run using `grunt|gulp build`
39
39
40
+
Tests
41
+
-----
42
+
43
+
Please add unit and integration tests if you can. It's always nice if our code coverage improves bit by bit (literally!). We are using [Node Tap](http://www.node-tap.org/) as test framework and [Rewire](https://github.com/jhnns/rewire) for mocking things like file system access.
44
+
40
45
Branching Scheme
41
46
----------------
42
47
43
-
 While actively maintaining `2.X` on `master`, there is heavy development going on for Patternlab `3.X`. Currently Pattern Lab has the following branches:
48
+
 Currently Pattern Lab has the following branches:
44
49
45
-
-**master** contains the latext stable, released `2.X` version</dd>
46
-
-**dev**: for `2.X` development. Please target pull requests against this branch
47
-
-**dev-3.0** Development branch for version `3.0`. Pattern Lab has undergone some major changes and the source trees have diverged a lot and we will try to forward-port any changes made in `2.X`
48
-
-**feature-branches** for larger changes. Allows merging all changes into both `2.X` and `3.X` easily.
50
+
-**master** contains the latext stable, released version</dd>
51
+
-**dev**: for development. *Please target pull requests against this branch.*
52
+
-**feature-branches** for larger changes. Allows merging all changes into both `dev` easily.
49
53
-**long running branches** for changes that involve major changes to the code, architecture and take a lot of time (i.e. making Pattern Lab async)
50
54
51
-
Development mainly happens in the `dev` branch, but you can help us a lot if you also do a pull request against `dev-3.0`. When `dev` seems stable enough, we do releases of `2.X` by merging `dev` to `master` and creating a release tag.
55
+
Development mainly happens in the `dev` branch, but you can help us a lot if you also do a pull request. When `dev` seems stable enough, we do releases by merging `dev` to `master` and creating a release tag.
56
+
57
+
Feature branches target `dev` and should be updated regularly.
52
58
53
-
Feature branches may target either `dev` and/or `dev-3.0`and should be updated regularly.
59
+
Long running branches should only target the latest version of Pattern Lab and may be lagging behind a lot.
54
60
55
-
Long running branches should only target the latest version of Pattern Lab, currently `dev-3.0`, and may be lagging behind a lot.
61
+
Gitter.im Chat
62
+
==============
56
63
57
-
If you have any questions or you would like to help, feel free to ask on [our Gitter.im](https://gitter.im/pattern-lab/node-team)
64
+
If you have any questions or you would like to help, feel free to ask on [our Gitter.im channel](https://gitter.im/pattern-lab/node):smiley:
0 commit comments