@@ -15,22 +15,44 @@ actions.**
1515
1616## Development
1717
18- If you want to fix bugs or add new features, please clone the source via
19-
20- ``` bash
21- $ npm run test
22- ```
18+ If you want to fix bugs or add new features, ** please read this chapter and it's
19+ sections carefully!**
2320
2421### No PR without issue
2522
2623Please make sure your commitment will be appreciated by first opening an issue
2724and discuss, whether this is a useful addition to the project.
2825
26+ ### Work on a bug or a new feature
2927
30- ### Run the tests
28+ First, clone and install this project from source via
3129
32- Please always make sure your code is passing linter and tests ** before**
33- committing. By doing so you help to make reviews much easier and don't pollute
30+ ``` bash
31+ $ git clone git@github.com:node-oauth/node-oauth2-server.git
32+ $ cd node-oauth2-server
33+ $ git checkout developmemt # important! do not work on master!
34+ $ npm install
35+ ```
36+
37+ From here you can run several scripts for development purposes:
38+
39+ ``` bash
40+ $ npm run lint # runs the linter
41+ $ npm run tets # runs the tests once
42+ $ npm run tests:coverage # runs the tests including coverage
43+ $ npm run docs # generates the API docs
44+ ```
45+
46+ To work on a new feature or a fix please create a new branch:
47+
48+ ``` bash
49+ $ git checkout -b feature-xyz # or fix-xyz
50+ ```
51+
52+ ### Run the tests before committing
53+
54+ Please always make sure your code is passing linter and tests ** before
55+ committing** . By doing so you help to make reviews much easier and don't pollute
3456the history with commits, that are solely targeting lint fixes.
3557
3658You can run the tests via
@@ -95,6 +117,9 @@ Finally your PR needs to pass the review process:
95117
96118## For maintainers
97119
120+ Maintainers of this repository have an extended responsibility for security and
121+ integrity. Therefore you have to take extra care on preparing publishing.
122+
98123### When to release a new version?
99124
100125- on fixed vulnerabilities
0 commit comments