- I have read the contributing guidelines
- Add test cases to all the changes you introduce
- Run
poetry alllocally to ensure this change passes linter check and tests - Manually test the changes:
- Verify the feature/bug fix works as expected in real-world scenarios
- Test edge cases and error conditions
- Ensure backward compatibility is maintained
- Document any manual testing steps performed
- Update the documentation for the changes
- Run
poetry doclocally to ensure the documentation pages renders correctly - Check and fix any broken links (internal or external) in the documentation
When running
poetry doc, any broken internal documentation links will be reported in the console output like this:INFO - Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.