Skip to content

Commit ac58175

Browse files
committed
added a CONTRIBUTING.md, but will anybody read it?
1 parent 3438ee4 commit ac58175

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
examples/_*
12
examples/build
23
node_modules
34

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
### Commit subjects
2+
3+
If your patch changes the API or fixes a bug please use one of the
4+
following prefixes in your commit subject:
5+
6+
- `[fixed] ...`
7+
- `[changed] ...`
8+
- `[added] ...`
9+
- `[removed] ...`
10+
11+
When releasing, a changelog is created automatically, from these
12+
commits.
13+
14+
### Development
15+
16+
- `script/test` will fire up a karma runner and watch for changes in the
17+
specs directory.
18+
- `npm test` will do the same but doesn't watch, just runs the tests.
19+
- `script/build-examples` does exactly that.
20+
- `script/build-examples --watch` is a little more useful.
21+

0 commit comments

Comments
 (0)