Contribute
There are two ways to contribute to Concrete Numpy or to Concrete tools in general:
You can open issues to report bugs and typos and to suggest ideas.
You can ask to become an official contributor by emailing hello@zama.ai. Only approved contributors can send pull requests, so please make sure to get in touch before you do!
Now, let's go over some other important items that you need to know.
Creating a new branch
We are using a consistent branch naming scheme, and you are expected to follow it as well. Here is the format:
...and some examples:
Before committing
Conformance.
Each commit to Concrete Numpy should conform to the standards decided by the team. Conformance can be checked using the following command:
Testing.
On top of conformance, all tests must pass with 100% code coverage across the codebase:
There may be cases where covering 100% of the code is not possible (e.g., exceptions that cannot be triggered in normal execution circumstances). In those cases, you may be allowed to disable coverage for some specific lines. This should be the exception rather than the rule. Reviewers may ask why some lines are not covered and, if it appears they can be covered, then the PR won't be accepted in that state.
Committing
We are using a consistent commit naming scheme, and you are expected to follow it as well. Again, here is the accepted format:
...and some examples:
To learn more about conventional commits, check this page.
Before creating a pull request
We remind you that only official contributors can send pull requests. To become an official contributor, please email hello@zama.ai.
You should rebase on top of the main
branch before you create your pull request. We don't allow merge commits, so rebasing on main
before pushing gives you the best chance of avoiding rewriting parts of your PR later if conflicts arise with other PRs being merged. After you commit your changes to your new branch, you can use the following commands to rebase:
You can learn more about rebasing in here.
Last updated