Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (36 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

58 lines (36 loc) · 3.23 KB

Contributing

We welcome contributions to this project. Please follow our code of conduct (CODE_OF_CONDUCT).

To make code changes you will need to fork the project. Thereafter follow the set up instructions in the README file.

If you don't want to make changes yourself, but would like to make a suggestion or comment, you can open an issue.

Opening an issue

We recommend opening an issue in the following situations:

  • Reporting an error you can’t solve yourself
  • Discussing a high-level topic or idea (for example, community, vision or policies)
  • Proposing a new feature or other project idea

This list is adapted from Open Source Guides.

Opening a pull request

Opening a pull request is appropriate when:

  • You are submitting trivial fixes (for example, a typo, a broken link or an obvious error)
  • You are planning to start work on a contribution that was already asked for, or that you’ve already discussed, in an issue

These cases are adapted from Open Source Guides.

If you decide to tackle an issue yourself, these are the steps you'll need to take to make a pull request.

  1. Fork the repo
  2. Clone your fork
  3. Create a local branch
  4. Run the project
  5. Make your changes, and test them by running the site locally
  6. Add the changes you made in the working directory to the staging area
  7. Commit your changes, together with a short description, and referencing any related issues
  8. Push your changes to your fork
  9. Create a pull request from your fork to the original, upstream project
  10. Receive feedback, iterate as necessary
  11. Once we have accepted your pull request, we will merge your changes into the project main branch

You can read more about contributing to the project at https://responsibletech.work/contribute/.

Forking the repository

Before contributing to the project, create a fork and clone it locally. If you're not sure how to do this, Kent C. Dodds has a helpful video guide to forking and cloning a git repository.

GitHub has this text-only guide to forking a repo.

Creating a pull request

Once you have the project running locally, create a new branch for the issue you want to work on. Remember to regularly pull changes from "upstream" to reduce the likelihood of merge conflicts.

To make a pull request, we recommend clicking the Compare & pull request button in GitHub. If this is no longer visible (it disappears after an hour or so), click the New pull request button and select the compare across forks link. Set the head repository (head fork) to your fork, and the branch that you are comparing to the branch you just pushed.

The default message of the pull request is the message you added to your commit. Please add as much information as you can to the body of the request; you cannot be too verbose!

If any of this is unclear, Ken C. Dodds has another useful how-to video, how to create a pull request on github.