Contributing to legate-raft#

Contributions to legate-raft fall into the following categories:

To report a bug, request a new feature, or report a problem with documentation, please file an issue describing the problem or new feature in detail. The RAPIDS team evaluates and triages issues, and schedules them for a release. If you believe the issue needs priority attention, please comment on the issue to notify the team.
To propose and implement a new feature, please file a new feature request issue. Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it.
To implement a feature or bug fix for an existing issue, please follow the code contributions guide below. If you need more context on a particular issue, please ask in a comment.

As contributors and maintainers to this project, you are expected to abide by the code of conduct. More information can be found at: Contributor Code of Conduct. Code contributions must follow the guidelines below.

Code contributions#

Please see the README.md for information on how to set up a development environment and building legate-raft.

legate-raft is still in an exploratory phase we plan on improving infrastructure and additional documentation as the project matures.

Testing#

legate-raft includes pytest tests and runs them in CI. After installing you can run these quickly using:

./ci/run_pytests.sh

This will launch pytest in legate using all local GPUs. The CI setup only tests with a single GPU, so that it is necessary to run tests locally to check distributed algorithms.

For full control of the legate launch parameters, you can run the tests from the test folder for example using:

cd legate-raft/test
LEGATE_TEST=1 legate --gpus=2 --module pytest .

Pre-commit hooks#

legate-raft uses pre-commit to execute all code linters and formatters. Any code contributions must pass the pre-commit checks.

Signing Your Work#

We require that all contributors “sign-off” on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
- Any contribution which contains commits that are not Signed-Off will not be accepted.
To sign off on a commit you simply use the --signoff (or -s) option when committing your changes:
```
$ git commit -s -m "Add cool feature."
```
This will append the following to your commit message:
```
Signed-off-by: Your Name <your@email.com>
```

Full text of the DCO:

  Developer Certificate of Origin
  Version 1.1

  Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
  1 Letterman Drive
  Suite D4700
  San Francisco, CA, 94129

  Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

  Developer's Certificate of Origin 1.1

  By making a contribution to this project, I certify that:

  (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.