amirho/express
1
0
Fork 0
mirror of https://github.com/expressjs/express.git synced 2026-02-21 19:41:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update collaborator guide

Browse Source
This commit is contained in:
Rand McKinney
2017-02-15 17:18:57 -08:00
committed by Douglas Christopher Wilson
parent 3e3d35777d
commit f3a47e39a4
1 changed files with 22 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
Collaborator-Guide.md
View File

@@ -6,25 +6,36 @@ Open issues for the expressjs.com website in https://github.com/expressjs/expres
## PRs and Code contributions
* Tests must pass.
* Follow existing coding style.
* Follow the [JavaScript Standard Style](http://standardjs.com/).
* If you fix a bug, add a test.
## Branches
* Use the `master` branch for bug fixes or minor work that is intended for the current release stream
* Use the correspondingly named branch, e.g. `5.0`, for anything intended for a future release of Express
Use the `master` branch for bug fixes or minor work that is intended for the
current release stream.
Use the correspondingly named branch, e.g. `5.0`, for anything intended for
a future release of Express.
## Steps for contributing
* [Create an issue](https://github.com/expressjs/express/issues/new) for the bug you want to fix or the feature that you want to add.
* Create your own [fork](https://github.com/expressjs/express) on github, then checkout your fork.
* Write your code in your local copy. It's good practice to create a branch for each new issue you work on, although not compulsory.
* To run the test suite, first install the dependencies by running `npm install`, then run `npm test`.
* If the tests pass, you can commit your changes to your fork and then create a pull request from there. Make sure to reference your issue from the pull request comments by including the issue number e.g. #123.
1. [Create an issue](https://github.com/expressjs/express/issues/new) for the
bug you want to fix or the feature that you want to add.
2. Create your own [fork](https://github.com/expressjs/express) on github, then
checkout your fork.
3. Write your code in your local copy. It's good practice to create a branch for
each new issue you work on, although not compulsory.
4. To run the test suite, first install the dependencies by running `npm install`,
then run `npm test`.
5. If the tests pass, you can commit your changes to your fork and then create
a pull request from there. Make sure to reference your issue from the pull
request comments by including the issue number e.g. `#123`.
## Issues which are questions
We will typically close any vague issues or questions that are specific to some app you are writing. Please double check the docs and other references before being trigger happy with posting a question issue.
We will typically close any vague issues or questions that are specific to some
app you are writing. Please double check the docs and other references before
being trigger happy with posting a question issue.
Things that will help get your question issue looked at:
@@ -33,4 +44,5 @@ Things that will help get your question issue looked at:
* Clear description of the expected result.
* Steps you have taken to debug it yourself.
If you post a question and do not outline the above items or make it easy for us to understand and reproduce your issue, it will be closed.
If you post a question and do not outline the above items or make it easy for
us to understand and reproduce your issue, it will be closed.