Skip to content

Latest commit

 

History

History
73 lines (43 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

73 lines (43 loc) · 4.38 KB
Raw

Contributing Guidelines

Welcome to the Reproducible Research GitHub repository, and thank you for thinking about contributing! 😃❤️😃

The point of this file is to make it suuuuuper 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.

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

If you have a question or aren't sure about how to get started, please take a look through the issues to see if anyone else has asked the same thing, and if they haven't start a new one and ask away! 😃

Make a change

  1. First, describe what you're planning to do as a new issue or a comment to an existing issue.

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

  2. Fork the Reproducible Research 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 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.

    Kirstie will review your changes, maybe have a bit of discussion and hopefully merge them in!

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

How to get in touch

If you have a question or a comment we'd love for you to open an issue because that will be our fastest way of communicating, getting the answers to you and (if necessary) making a change.

If you'd prefer email you can contact Kirstie at kw401 AT cam DOT ac DOT uk. She's a postdoc who is gloriously overworked (who isn't?!), so please be gentle in your correspondence and give her a couple of days to reply. If she doesn't reply to your email before or during her regular "office hours" on Tuesday afternoons please feel free to ping her again.

Thank you!

You are awesome. 😍✨☀️

And if you've found typos in this (or any other) page, you could consider submitting your very first pull request to fix them via the typos and broken links issue!