We gladly accept PRs and issues to improve this project.
- Submit a GitHub issue if you want to discuss design prior to creating a pull request.
- Format files in accordance with the language conventions.
- Include tests. If there are existing tests extend them with new cases. Otherwise create automated tests.
- Keep documentation current. Update README.md files to describe new behavior and remove obsolete instructions.
- Keep documentation concise. Provide only essential information and commands needed to complete tasks.
- Place Apache 2.0 header comments in Python files.
- Validate all Python code using
black . && isort . && flake8 .
- Use Python unittest to write tests.
- Write a docstring on the unit test class to decribe the test.
- Write a docstring on each test case method to document the proposition that it tests.
- Keep code as short as possible. Put repeated test code in helper functions.
- Dump all information needed to debug failures.
Feel free to use AI tools but add this file to the context by telling your AI agent to follow these rules for design and code gen activities.
- AI agents are required to read and follow these conventions.
- Developers are required to verify all code, including code generated by AI agents.