Contributing

• Guidelines for Contributing
• Opening issues
• Contributing code via pull requests
  • Steps before starting work
    • If an issue ticket exists
    • If an issue ticket doesn’t exist
    • In the event of a conflict
    • If the issue ticket has someone assigned to it
  • Making the pull request
    • Code Formatting
    • Docstring formatting and type hints
  • Steps
  • Pull request checklist
  • Developing in Docker
    • container.sh & container.ps1
    • Testing in Docker
    • Using the Docker image interactively
    • Building documentation with Docker
  • Running the benchmark tests
• Developer Guide
  • Backends
    • Code Separation
    • Test Separation
    • Gallery Examples
  • Documentation
    • Docstring style
    • Hyperlinks

Usage Guidelines for Contributing