Skip to content

Latest commit

 

History

History
74 lines (45 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

74 lines (45 loc) · 3.97 KB

Contributing to the website

Thank you for thinking about contributing! 😃

The point of this file is to make it super easy for you to get involved. So if you have any questions that aren't covered here please let us know! Check out the Share your thoughts section below for more details.

Before you start you'll need to set up a free GitHub account and sign in. Here are some instructions.

Scroll down or jump to one of the following sections:

Share your thoughts

Although GitHub calls them issues, we'd like you to think of them as conversation starters. They're our way of communicating across all the members of the team.

(If you're here you already are a member of the team.)

GitHub has a nice set of help pages if you're looking for more information about discussing projects in issues.

You can find all currently open conversations under the issues tab.

Make a change

Once you've identified one of the issues above that you feel you can contribute to, you're ready to make a change to the project repository! 🎉😃

  1. First, describe what you're planning to do as a comment to the issue, (and this might mean making a new issue).

    Check in with a couple of other members of the team to ensure you aren't overlapping with work that's currently underway and that everyone is on the same page with the goal of the work you're going to carry out.

    This blog is a nice explanation of why putting this work in up front is so useful to everyone involved.

  2. Fork the project repository to your profile.

    You can now do whatever you want with this copy of the project. You won't mess up anyone else's work so you're super safe.

    Make sure to [keep your fork up to date][link_updateupstreamwiki] with the master repository.

  3. Make the changes you've discussed.

    Try to keep the changes focused rather than changing lots of things at once. If you feel tempted to branch out then please literally branch out: create separate branches for different updates to make the next step much easier!

  4. Submit a pull request.

    A member of the executive team will review your changes, have a bit of discussion and hopefully merge them in!

Success!! 🎈🎈🎈 Well done! And thank you 😃🎉✨

Add yourself as a contributor

Please feel free to add yourself as a contributor in the README of this project, even if your participation doesn't involve coding! Follow the hints here to do so.

Thank you!