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 [email protected] 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:
git checkout -b {feat|fix|refactor|test|benchmark|doc|style|chore}/short-description
...and some examples:
git checkout -b feat/direct-tlu
git checkout -b fix/tracing-indexing

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:
make pcc

Testing.

On top of conformance, all tests must pass with 100% code coverage across the codebase:
make pytest
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:
make show_scope
...and some examples:
git commit -m "feat: implement bounds checking"
git commit -m "feat(debugging): add an helper function to draw intermediate representation"
git commit -m "fix(tracing): fix a bug that crashed pytorch tracer"
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 [email protected]
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:
# fetch the list of active remote branches
git fetch --all --prune
# checkout to main
git checkout main
# pull the latest changes to main (--ff-only is there to prevent accidental commits to main)
git pull --ff-only
# checkout back to your branch
git checkout $YOUR_BRANCH
# rebase on top of main branch
git rebase main
# If there are conflicts during the rebase, resolve them
# and continue the rebase with the following command
git rebase --continue
# push the latest version of the local branch to remote
git push --force
You can learn more about rebasing in here.
Export as PDF
Copy link
On this page
Creating a new branch
Before committing
Conformance.
Testing.
Committing
Before creating a pull request