Contributing
Contributing to IndiaPRIDE AutoDoc
Thank you for your interest in contributing.
Development Guidelines
- Follow PEP 8 coding standards.
- Use Python 3.11.
- Keep modules focused and modular.
- Write clear docstrings and comments where appropriate.
- Add or update tests when introducing new functionality.
- Update the changelog for significant changes.
Git Workflow
- Create a feature branch for new work.
- Write clear, descriptive commit messages.
- Keep commits focused on a single logical change.
Code Quality
Before submitting changes:
- Ensure the project runs without errors.
- Run formatting and linting tools.
- Verify that existing functionality is not broken.
Documentation
Documentation is considered part of the project. Please update relevant documentation whenever behavior or APIs change.