Contributing

Thank you for your interest in contributing to Maha! Small improvements or bug fixes are always appreciated. In addition to writing code, Maha accepts many kinds of contributions, including:

• Help with outreach and onboard new contributors

• Maintain and improve our documentation

• Add more edge cases to our test suite

• Review and approve pull requests

• Report bugs and provide feedback directly on GitHub

• Develop tutorials, presentations, and other educational materials

Note

However you decide to contribute or interact with the community, please always be civil and respect other members of the community.

Contributing can be confusing, so here are a few guides:

• Contribution Guidelines
  • For first-time contributors
  • Develop your contribution
  • Polishing Changes and Submitting a Pull Request
• Adding Docstrings
  • Formatting the Docstrings
  • NumPy Format
• Adding References
  • Reference to types in documentation
• Adding Admonitions
  • Adding Blocks for Tip, Note, Important etc. (Admonitions)

Copyright notice

Contribution guidelines are mostly based on the Manim’s Contributing