Skip to content

a place for people to practice GitHub operations as part of the gitgood workshop

License

Notifications You must be signed in to change notification settings

the-turing-way/gitgood-practice-space

Repository files navigation

GitGood practice space

About this Repository

This is the "practice space" repository to be used by participants in The Turing Way GitGood workshops

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 to this repository!

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 useful 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):

Added a new line :D

Cassandra Gould van Praag
Cassandra Gould van Praag

📖

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

About

a place for people to practice GitHub operations as part of the gitgood workshop

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 11