Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

73 lines (57 loc) · 3.74 KB
Raw

How to contribute?

First of all, thanks for taking the time to contribute! 🎉👍

This repository is a place to share resources for the tutorial "Building a Jupyter Book with The Turing Way". We welcome all the suggestions and contributions to improve this tutorial. You can report mistakes and errors, propose a topic for discussion, offer resources to enhance the current modules.

We have a Code of Conduct that applies to all the activities on this repository.

Whatever is your background and availability, there is a way to contribute on this GitHub repository.

🏃 I'm busy, I only have 1 minute

Get in touch with the developers and maintainers of this project by dropping an email to express your interest to get involved. (Malvika Sharan (email: [email protected]), Martina G. Vilas (email: [email protected]) and/or Sarah Gibson (email: [email protected]))

⏳ I've read/used the resources and now I have 5 minutes - tell me what I can do

  • Open an issue to report errors/bugs, share your feedback or suggest any improvement that can help other users of this tutorial.
  • Open a pull request to fix any error, clarify any part of this tutorial that is not clear or contribute examples.

🎉 I am committed to contributing to The Turing Way and Jupyter Book in the future

Both the projects have contribution guidelines that will help you get started as a contributor and get onboarded in the community.

Please visit their GitHub repository for more details:

🛠 I am ready to contribute to the tutorial and/or the projects

  • For open tasks in this repository, please see the Issues sections in this repository.
  • For open tasks in The Turing Way repository, please visit their Issues section.
  • For open tasks in Jupyter Book repository, please visit their Issues section.
  • Raise mistakes, error or missing information on these repositories by opening Pull Request
    • Read details on how to open a Pull request
    • Submit trivial fixes (for example, a typo, a broken link or an obvious error)
    • Start work on a contribution that is already listed as an issue, or something you’ve already discussed
    • A pull request doesn’t have to represent finished work. It’s usually better to open a pull request early on, so others can watch or give feedback on your progress. You can mark it as a “WIP” (Work in Progress) in the subject line. You can always add more commits later.

Acknowledgements 🙌

This project is developed and maintained by Malvika Sharan, Martina Vilas and Sarah Gibson. The project leads of The Turing Way, Kirstie Whitaker and Jupyter Book, Chris Holdgraf have provided support in developing this tutorial.

This work is licensed under a Creative Commons Attribution 4.0 International license. You are free to share and adapt the material for any purpose, even commercially, as long as you provide attribution (give appropriate credit, provide a link to the license, and indicate if changes were made) in any reasonable manner, but not in any way that suggests the licensor endorses you or your use, and with no additional restrictions.