From 24c70672f0a36f022cc8d21935a22bb4af076901 Mon Sep 17 00:00:00 2001 From: Mark Owsiak Date: Fri, 19 Oct 2018 16:36:52 -0400 Subject: [PATCH] Improve Contributing Docs (#3525) * docs: improve CONTRIBUTING.md and fix/remove links * docs: link to CONTRIBUTING.md in readme * docs: address PR comments [skip ci] * docs: better wording on PR review wait time [skip ci] --- .github/CONTRIBUTING.md | 9 +++++---- README.md | 3 ++- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index dc7b817cca..8f23330549 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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 ` -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. 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. @@ -69,14 +70,14 @@ 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. This can take a while. We may request changes, but don't be afraid to question them. ## :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). -- **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). +- **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 well?** Help with the documentation. See the [issues for our site](https://github.com/mochajs/mocha/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation). - **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. - **Want to build our community?** Mocha has a *lot* of users. We could use your help bringing everyone together in peace and harmony. Please contact an [org member](https://github.com/mochajs/people). diff --git a/README.md b/README.md index 9655920d56..8128519691 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,10 @@ ## Links -- **[Documentation](https://mochajs.org)** +- **[Documentation](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)