👉 <link to the HackMD>
Please add your name to this list, but remember that this is a public document, so use a pseudonym if you'd prefer, or just feel free to leave your name off.
- Name / Institute / Twitter, GitHub
- Intro to Book Dash slides:
<link to intro slides> - Project repository: https://github.com/alan-turing-institute/the-turing-way
- Book hosted at: https://book.the-turing-way.org
- Gitter chat room: https://gitter.im/alan-turing-institute/the-turing-way
- Twitter hashtag: #TuringWay
Please read and follow our project Contributing Guidelines! ✨ If you find them confusing, difficult to follow or think that information needs to be added, please let us know! This will help us improve the contributing experience for everyone going forward.
The tl;dr version for easy reference during dashing:
- Comment on an existing issue or open a new issue referencing your addition.
- The issue template will automatically be rendered in the comment section of the new issue page, so all you need to do is edit the "Lorem ipsum" sections.
- Add the
book-dash-<location>label in the column on the right.
- Fork the Turing Way repository to your GitHub profile.
- Make your changes!
- Submit a pull request.
- Open a pull request as early in your contributing process as possible and add the label [WIP] to the title to designate "work in progress".
- The pull request template will automatically be rendered in the comment section of the new pull request page, so all you need to do is edit the "Lorem ipsum" sections.
- Add the
book-dash-<location>label in the column on the right. - As you continue to make changes they will automatically be included in your existing pull request.
- Change [WIP] to [Ready for review] in the pull request title when you are happy for your contribution to be reviewed and merged. 🎉
What types of contributions can you make?
- Check out the list of open issues
- Proofread existing chapters (check for typos, grammar, links, etc.)
- Add further information to an existing chapter
- Suggest topics for new chapters (particularly if you can write them!)
- A chapter can be 3 paragraphs in length - what can you write 3 paragraphs on?
- What skills or tools do you wish you had been taught at the start of your research career?
- Review
[Ready to review]pull requests - Contribute to discussion in
[WIP]pull requests and issues - Submit a case study or your tips and tricks for reproducible research via our Google submission form.
- Incorporate case studies into the book
- Checklists
- Restructuring the chapter sections (like the Reproducibility chapter)
- Creative, out of the box ideas!
- Let us know if you are struggling with contributing in any way so that we can improve our Contributing Guidelines!
Click here to accept your invitation to have write access to The Turing Way - this gives you agency to merge your own pull requests (once approved!), review other pull requests, and add labels to issues and pull requests.
You're going to start getting lots of notifications from The Turing Way GitHub repository 🙀
You can control these at the https://github.com/settings/notifications page.
We recommend leaving the "Participating" options checked ✅ and un-checking the "Watching" boxes so you don't get a million different notifications.
Here's a useful help page: https://help.github.com/en/articles/about-notifications
Octobox is a cool tool for managing your GitHub notifications: https://octobox.io
Please get into groups of 2 or 3 and have an explore about what you'd like to see in this book, or how you can contribute. ✨ 👾 🚀 🌟
List what you are working on below! Include your GitHub username, one sentence description and links to relevant issues and pull requests.
There's also an issue for feedback - any comments on what we can do better at future events are appreciated: <link to issue>
<link to Pluses and deltas HackMD>