Here are the guidelines for contributing to Numerous SDK! They are chosen with the aim of creating a good environment for developing Numerous SDK to a high level of quality and consistency.
We recommend setting up the pre-commit hooks defined in the repository to ensure that all linters and tests are passing before a commit or push.
Reviews in general require tests and linters to pass.
We expect contributors to familiarize themselves with the Google Go Style Guide, in particular the actual style guide itself, and the set of best practices.
These documents can be referenced in reviews for code style suggestions.
Above all, we encourage developers to prioritize designing their code so that it is readable and understandable by other developers (or themselves, in the future!), easy to modify, and testable.
We also expect new features added to have an associated test suite, which should be usable as documentation to understand the expectations of the new code.
In the python SDK, we document modules, functions, classes, and methods using docstrings. We use the Google Docstring format.
When creating a pull request with changes, please consider the following points:
- We use conventional commits, for automated semantic versioning.
- Make sure the pull request branch is rebased on top of
main. - Even within your pull request branch, try to ensure that linters and tests pass locally, before pushing.