Collaborator-Guide.md

   1 # Express Collaborator Guide
   2
   3 ## Website Issues
   4
   5 Open issues for the expressjs.com website in https://github.com/expressjs/expressjs.com.
   6
   7 ## PRs and Code contributions
   8
   9 * Tests must pass.
  10 * Follow the [JavaScript Standard Style](http://standardjs.com/) and `npm run lint`.
  11 * If you fix a bug, add a test.
  12
  13 ## Branches
  14
  15 Use the `master` branch for bug fixes or minor work that is intended for the
  16 current release stream.
  17
  18 Use the correspondingly named branch, e.g. `5.0`, for anything intended for
  19 a future release of Express.
  20
  21 ## Steps for contributing
  22
  23 1. [Create an issue](https://github.com/expressjs/express/issues/new) for the
  24    bug you want to fix or the feature that you want to add.
  25 2. Create your own [fork](https://github.com/expressjs/express) on GitHub, then
  26    checkout your fork.
  27 3. Write your code in your local copy. It's good practice to create a branch for
  28    each new issue you work on, although not compulsory.
  29 4. To run the test suite, first install the dependencies by running `npm install`,
  30    then run `npm test`.
  31 5. Ensure your code is linted by running `npm run lint` -- fix any issue you
  32    see listed.
  33 6. If the tests pass, you can commit your changes to your fork and then create
  34    a pull request from there. Make sure to reference your issue from the pull
  35    request comments by including the issue number e.g. `#123`.
  36
  37 ## Issues which are questions
  38
  39 We will typically close any vague issues or questions that are specific to some
  40 app you are writing. Please double check the docs and other references before
  41 being trigger happy with posting a question issue.
  42
  43 Things that will help get your question issue looked at:
  44
  45 * Full and runnable JS code.
  46 * Clear description of the problem or unexpected behavior.
  47 * Clear description of the expected result.
  48 * Steps you have taken to debug it yourself.
  49
  50 If you post a question and do not outline the above items or make it easy for
  51 us to understand and reproduce your issue, it will be closed.