diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ca9fbfff..1e321d46 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,25 +24,25 @@ Before you get your hands dirty, please [search](https://github.com/http-party/h Follow these steps to get going. 1. [Install the latest version of Node.js](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. + - 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 fork, giving it a descriptive name 1. Execute `npm install` to install the prod and dev dependencies - - Do not use `yarn install` for development, as it may not get the same package versions as other developers. + - Do not use `yarn install` for development, as it may not get the same package versions as other developers. 1. Make your changes and add them via `git add`. - - **Tests are required** for any non-trivial code change. If you're having trouble making tests, go ahead and open the pull request and we can help - - Keep your PR focused. Don't fix multiple things at once, and don't upgrade dependencies unless necessary. + - **Tests are required** for any non-trivial code change. If you're having trouble making tests, go ahead and open the pull request and we can help + - Keep your PR focused. Don't fix multiple things at once, and don't upgrade dependencies unless necessary. 1. Before committing, run `npm test` - - Tests will also run on your PR, but running them locally will let you catch problems ahead-of-time. + - Tests will also run on your PR, but running them locally will let you catch problems ahead-of-time. 1. Commit your changes. - - See [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/). + - See [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/). 1. Push your changes to your fork. 1. Now on [http-party/http-server](https://github.com/http-party/http-server), you should see a notification about your recent changes in your fork's branch, with a green button to create a pull request. Click the button. 1. Describe your changes in detail here, following the template. Once you're satisfied, submit the form. 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. 1. Your PR might become conflicted with the code in `master`. If this is the case, you will need to [update your PR](#up-to-date) and resolve your conflicts. 1. You don't need to make a new PR to any needed 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. - - **Please do not rebase and force-push**, it ruins the git history + - **Please do not rebase and force-push**, it ruins the git history ## :angel: I Just Want To Help