Our project welcomes external contributions. If you have an itch, please feel free to scratch it.
To contribute code or documentation, please submit a pull request.
A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the issue tracker. Before embarking on a more ambitious contribution, please quickly get in touch with us.
For general questions or support requests, please refer to the discussion section.
Note: We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in backlog for a long time, or cannot be accepted at all!
If you would like to implement a new feature, please raise an issue before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base.
If you would like to fix a bug, please raise an issue before sending a pull request so it can be tracked.
The project maintainers use LGTM (Looks Good To Me) in comments on the code review to indicate acceptance. A change requires LGTMs from two of the maintainers of each component affected.
For a list of the maintainers, see the MAINTAINERS.md page.
Each source file must include a license header for the MIT Software. Using the SPDX format is the simplest approach. e.g.
/*
Copyright IBM Inc. All rights reserved.
SPDX-License-Identifier: MIT
*/
We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. We use the same approach - the Developer's Certificate of Origin 1.1 (DCO) - that the Linux® Kernel community uses to manage code contributions.
We simply ask that when submitting a patch for review, the developer must include a sign-off statement in the commit message.
Here is an example Signed-off-by line, which indicates that the submitter accepts the DCO:
Signed-off-by: John Doe <[email protected]>
You can include this automatically when you commit a change to your local git repository using the following command:
git commit -s
Please feel free to connect with us using the discussion section.
We support Python 3.8 and above, and use Poetry for dependency management.
We recommend creating the virtual environment like this:
poetry env use $(which python3.8)To create an environment using Python 3.8.
- A Redis server
- A RabbitMQ server
Note: A default set up using Visual Studio Code Containers has already been set up for you, with the required dependencies.
We use Pytest for running unit tests. To run the tests, do:
pytest test/
The tests are configured to point to the Redis and RabbitMQ configured in docker-compose.yaml. You may need to update them if you have a different setup.
We use the following tools to enforce code style:
- iSort, to sort imports
- Black, to format code
- Pylint, to lint code
- (TODO) Mypy
Please make sure to follow these tools's recommendations to help ensure good code quality.
We use MkDocs to write documentation.
To run the documentation server, do:
mkdocs serveThe server will be available on http://localhost:8000.
Run the following:
mkdocs gh-deploy