Skip to content
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.

Sign up for GitHub

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

Improve Contributing Docs #3525

Merged
merged 4 commits into from
Oct 19, 2018
Merged

Improve Contributing Docs #3525

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
71f024b
docs: improve CONTRIBUTING.md and fix/remove links
markowsiak Oct 19, 2018
eb0ae03
docs: link to CONTRIBUTING.md in readme
markowsiak Oct 19, 2018
c371960
docs: address PR comments [skip ci]
markowsiak Oct 19, 2018
2e8bad3
docs: better wording on PR review wait time [skip ci]
markowsiak Oct 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ Follow these steps to get going. If you are having trouble, don't be afraid to

> PRO TIP: Run `npm start` to see a list of commands which can be run with `npm start <command>`

1. [Install Node.js 4.x or newer](https://nodejs.org/download).
1. [Install Node.js 6.x or newer](https://nodejs.org/en/download/).
- If you're new to installing node a tool like [nvm](https://github.com/creationix/nvm#install-script) can help you manage multiple version installations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

- If you're new to installing Node, a tool like

1. Follow [Github's documentation](https://help.github.com/articles/fork-a-repo/) on setting up Git, forking and cloning.
1. Create a new branch in your working copy. Give your branch a descriptive name, such as `issue/12345`: `git checkout -b issue/12345`.
1. Execute `npm install` to install the development dependencies.
Expand All @@ -69,13 +70,13 @@ Follow these steps to get going. If you are having trouble, don't be afraid to
- You don't need to make a new PR to make changes. Instead, commit on top of your changes, and push these to your fork's branch. The PR will be updated, and CI will re-run.
- Github will indicate if there's a conflict. If this happens, you will need to [rebase](https://help.github.com/articles/about-git-rebase/) your branch onto the `master` branch of the source repository. *Don't merge.*
- It's no longer necessary to "squash" your changes.
1. Be patient while your PR is reviewed. This can take awhile ([why?](https://github.com/orgs/mochajs/projects/4)). We may request changes; don't be afraid to question them.
1. Be patient while your PR is reviewed. We may request changes; don't be afraid to question them.
Copy link
Contributor

@plroebuck plroebuck Oct 19, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might want to re-add the "This can take a while." bit (without the link). LOL


## :angel: I Just Want To Help

*Excellent.* Here's how:

- **Handy with JavaScript?** Please check out the issues labeled [`help-wanted`](https://github.com/mochajs/mocha/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Ahelp-wanted).
- **Handy with JavaScript?** Please check out the issues labeled [`help-wanted`](https://github.com/mochajs/mocha/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
- **Can you write good (and do other stuff good too)?** Help with the documentation. See the [issues for our site](https://github.com/mochajs/mocha/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation).
Copy link
Contributor

@plroebuck plroebuck Oct 19, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Groan! Joke is too subtle. Fix **Can you write good (and do other stuff good too)?** too, please.

- **Design your thing?** [Our site](https://github.com/mochajs/mocha/tree/master/docs) needs your magic touch.
- **Know Mocha's codebase?** We could use your help triaging issues and/or reviewing pull requests. Please contact an [org member](https://github.com/orgs/mochajs/people), and we'll chat.
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- **[Documentation](https://mochajs.org)**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trivially, but this will be faster if the link ends with a slash.
https://mochajs.org/

- **[Release Notes / History / Changes](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)**
- [Code of Conduct](https://github.com/mochajs/mocha/blob/master/.github/CODE_OF_CONDUCT.md)
- [Contributing](https://github.com/mochajs/mocha/blob/master/.github/CONTRIBUTING.md)
- [Gitter Chatroom](https://gitter.im/mochajs/mocha) (ask questions here!)
- [Google Group](https://groups.google.com/group/mochajs)
- [Issue Tracker](https://github.com/mochajs/mocha/issues)
Expand Down