Skip to content

the-turing-way/gitgood

Repository files navigation

GitGood

About this Repository

This repository contains slides and materials for delivering the 'Git Good' workshops, developed by contributors to The Turing Way (TTW).

These workshops are designed for people with little to no experience of using Git or GitHub, to introduce you to how it can be used to collaborate on things other than code!

These workshops are interactive and contain exercises where you comment on an issue and submit a pull request. Exercises are completed in the accompanying repository https://github.com/the-turing-way/gitgood-practice-space.

Vision and Mission

  • Vision: To normalise reproducible, ethical, and collaborative research as the global standard, ensuring that data science is accessible to and beneficial for all of society.
  • Mission: To empower a diverse community of practitioners with the technical fluency to use GitHub as a catalyst for reproducible and collaborative research — translating the principles of The Turing Way into research workflows.

About

Git and GitHub are often thought of as tools for computer scientists or 'people who write code'. At TTW, however, we believe this powerful methdology can be applied to many aspects of your research workflow to make it more transparent, reproducible and collaborative.

The content of these workshops has evolved over the years, but the overall objective is for participants to be supported in collaborating on materials hosted by The Turing Way.

Agenda for the most recent workshop:

  • Part 1: What is Git & Github?
  • Exercise 1: Finding an Issue and contributing to a project
    • You will practice: Using issues to contribute and document decisions
  • Part 2: What is open source?
  • Part 3: Using GitHub online and in the terminal (demo)
  • Exercise 2: Editing a file and making a Pull Request
    • You will practice: Markdown; contributing, pull requests
  • Part 4: What can we make with Github? (Websites and Project Management)
  • Exercise 3 (take home): Make your own website

The Team

Contributing

  • How to contribute: Please follow TTW CONTRIBUTING - we welcome your input!
  • Code of Conduct: Interactions with this material are expected to follow TTW CODE_OF_CONDUCT to ensure a respectful project environment. A separate code of conduct may be in place for individual workshops; see workshop presentation materials for details.

Licensing

This project is licensed under the CC-BY-4.0 License for documentation and MIT License for code - see the LICENSE for details.

Citing & Acknowledgement

Citation Instructions:

  • See individual workshops for a doi which links to a citation
  • Please also cite The Turing Way:

    The Turing Way Community. (2025). The Turing Way: A handbook for reproducible, ethical and collaborative research (1.2.3). Zenodo. https://doi.org/10.5281/zenodo.15213042

Acknowledgment:

This repository uses the template created and maintained by The Turing Way team members and shared under CC-BY 4.0 for reuse: https://github.com/alan-turing-institute/reproducible-project-template.

Contact

  • Contact: Contact information for presenters of individual workshops are available in their workshop materials (see the workshops directory).

Checklist for setting an online repository

  • Add a README file
  • Add a CONTRIBUTING file
  • Add a LICENSE
  • Add a Code of Conduct
  • Install all-contributors bot
  • .gitignore file (choose from a template)
  • Issue templates
  • Create a directory with files for project management (meetings, reports, proposals), communications, materials
  • Connect repo with Zenodo
  • Add cff file for citation
  • Add badges

Contributors

Thanks goes to these wonderful people (emoji key):

Cassandra Gould van Praag
Cassandra Gould van Praag

📖 📋 📢
Hari Sood
Hari Sood

📋 📢 📖
Sophia Batchelor
Sophia Batchelor

📋 📢 📖
Esther Plomp
Esther Plomp

📋 📢 📖
Anne Lee Steele
Anne Lee Steele

📋 📢 📖
Emma Karoune
Emma Karoune

📋 📢 📖
GabinWK
GabinWK

📋 📢 📖
Malvika Sharan
Malvika Sharan

📋 📢 📖
Eirini Zormpa
Eirini Zormpa

📋 📢 📖
Ayesha Magill
Ayesha Magill

📋 📢 📖
Alexandra Araujo Alvarez
Alexandra Araujo Alvarez

📋 📢 📖
Vicky Hellon
Vicky Hellon

📋 📢 📖
andrepiza
andrepiza

📋 📢 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Test edit for Emma to review and merge the PR 🎉

About

A repository for organisation and delivery of materials for introductory training in GitHub ("GitGood")

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors