-
Notifications
You must be signed in to change notification settings - Fork 8
move contributing and collaboration guide to .github #10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
d229261
docs: add contributing.md
bjohansebas 59f2418
docs: rename contributing to governance
bjohansebas b81aee7
port: https://github.com/expressjs/.github/pull/18
bjohansebas cd6ef39
docs: add contributing guide for Express collaboration
bjohansebas ee42a09
docs: update links to captains and committers in governance document
bjohansebas 205be53
docs: move governance document to dicussions repo
bjohansebas 111ddc0
Update CONTRIBUTING.md
wesleytodd c080d8a
Update CONTRIBUTING.md
wesleytodd 1481610
Update CONTRIBUTING.md
wesleytodd 1466bed
Update CONTRIBUTING.md
wesleytodd 1905ca0
Update CONTRIBUTING.md
wesleytodd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Express Collaborator Guide | ||
|
|
||
| ## Website Issues | ||
|
|
||
| Open issues for the expressjs.com website in https://github.com/expressjs/expressjs.com. | ||
|
|
||
| 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. | ||
|
|
||
| ## PRs and Code contributions | ||
|
|
||
| * Tests must pass. | ||
| * Follow the [JavaScript Standard Style](https://standardjs.com/) and `npm run lint`. | ||
| * 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. `6.x`, for anything intended for | ||
| a future release of Express. | ||
|
|
||
| ## Steps for contributing | ||
|
|
||
| 1. Create an issue for the | ||
| bug you want to fix or the feature that you want to add. | ||
| 2. Create your own fork 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. Ensure your code is linted by running `npm run lint` -- fix any issue you | ||
| see listed. | ||
| 6. 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 | ||
wesleytodd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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: | ||
|
|
||
| * Full and runnable JS code. | ||
| * Clear description of the problem or unexpected behavior. | ||
| * 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 your question meets all of the above requirements but you do not believe it needs to be looked at | ||
| by the maintainers | ||
| (for example, if you are just looking for community input) please open it as a discussion topic instead | ||
| of an issue. If you | ||
| are unsure and open an issue, we may move it to discussions if we triage them and decide they do | ||
| not need high | ||
| visibility or maintainer input. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.