Contributing

Thank you for your eagerness to contribute to tobac. We have a step-by-step overview of the most important points: tobac-project/tobac on contributing, and this documentation goes into more detail.

• Code of conduct
• git Basics
• Writing proper documentation
  • Docstrings
  • Documentation Pages
  • Tips on working on documentation for your local code
  • Add examples
• Code reviews
  • How to do a code review
  • Tips and expectations
  • Conventional comments
• Code structure and key design concepts
  • Modules
  • Examples
  • Migrating to xarray and dask
• Testing
  • Writing unit tests
• Branching and Workflow
  • Our branching strategy
  • GitHub workflow
  • Releasing a new version
• Mentoring and Collaboration
  • Writing code collaboratively
  • Get a mentor
  • Pair reviews
• How to check the Sphinx-based rendering
  • 1. Preparing the Local Environment
  • 1. Building the Website
  • 3. Parsing Your Local Changes
  • Option: Check Rendering of a Pull requests