Contributing

Thank you for your interest in helping to improve Teacher! There are various ways to contribute to Teacher. All of them are super valuable but don’t necessarily require writing code at all. For example:

• contributing to the documentation

• opening new issues for bugs

• requesting new features

• asking for clarification on things you find unclear

• fixing bugs

Report a bug

Request a feature

Contribute code

Write documentation

• Contributing
  • Issues for new contributors
  • How to contribute
  • Contributing pull requests
• Setting up Teacher for development
  • Creating a dedicated environment
  • Retrieving the latest version of the code
  • Installing Teacher in editable mode
  • Installing pre-commit hooks
• Testing
  • Requirements
  • Running the tests
  • Using GitHub Actions for CI
• Writing documentation
  • Getting started
  • Writing ReST pages
  • Writing docstrings
• Dependencies
  • Runtime dependencies
  • Additional dependencies for testing
  • Additional dependencies for building documentation