Skip to content

Commit 573cb2c

Browse files
feat: move contributing and collaboration guide to .github (#10)
* docs: add contributing.md * docs: rename contributing to governance * port: #18 * docs: add contributing guide for Express collaboration * docs: update links to captains and committers in governance document * docs: move governance document to dicussions repo * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md --------- Co-authored-by: Wes Todd <[email protected]>
1 parent 5502faa commit 573cb2c

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
For issues in other Express managed repos (everything in `expressjs`, `pillarjs` or `jshttp` other than `expressjs/express`), be sure to check their contributing guide and open issues and PRs in the appropriate repository.
8+
9+
## PRs and Code contributions
10+
11+
* Tests must pass.
12+
* Follow the [JavaScript Standard Style](https://standardjs.com/) and `npm run lint`.
13+
* If you fix a bug, add a test.
14+
15+
## Branches
16+
17+
Use the `master` branch for bug fixes or minor work that is intended for the
18+
current release stream.
19+
20+
Use the correspondingly named branch, e.g. `6.x`, for anything intended for
21+
a future release of Express.
22+
23+
## Steps for contributing
24+
25+
1. Create an issue for the
26+
bug you want to fix or the feature that you want to add.
27+
2. Create your own fork on GitHub, then
28+
checkout your fork.
29+
3. Write your code in your local copy. It's good practice to create a branch for
30+
each new issue you work on, although not compulsory.
31+
4. To run the test suite, first install the dependencies by running `npm install`,
32+
then run `npm test`.
33+
5. Ensure your code is linted by running `npm run lint` -- fix any issue you
34+
see listed.
35+
6. If the tests pass, you can commit your changes to your fork and then create
36+
a pull request from there. Make sure to reference your issue from the pull
37+
request comments by including the issue number e.g. `#123`.
38+
39+
## Issues which are questions
40+
41+
We will typically close any vague issues or questions that are specific to some
42+
app you are writing. Please double check the docs and other references before
43+
being trigger happy with posting a question issue.
44+
45+
Things that will help get your question issue looked at:
46+
47+
* Full and runnable JS code.
48+
* Clear description of the problem or unexpected behavior.
49+
* Clear description of the expected result.
50+
* Steps you have taken to debug it yourself.
51+
52+
If you post a question and do not outline the above items or make it easy for
53+
us to understand and reproduce your issue, it will be closed.
54+
55+
If your question meets all of the above requirements but you do not believe it needs to be looked at
56+
by the maintainers
57+
(for example, if you are just looking for community input) please open it as a discussion topic instead
58+
of an issue. If you
59+
are unsure and open an issue, we may move it to discussions if we triage them and decide they do
60+
not need high
61+
visibility or maintainer input.

0 commit comments

Comments
 (0)