Thank you for your efforts to improve the fapolicy-analyzer project. This guide will help you regarding various aspects like submitting issues, contributing a feature, etc.
We write python bindings using PyO3 and setuptools_rust.
We use pipenv for creating a sand-boxed development environment. To install pipenv into your home directory:
pip3 install --user pipenv
To build and install the bindings, and to start the virtual development environment, run the following from the top level directory of this repository:
make shell
Note: There may be some additional build-time requirements. See the development wiki page for more details.
- Clone the repository
- Create a branch from
master - Run
make shellin the repository root - Change necessary code for bug fix, a new feature
- Check linting and format it
make lint
make format- Make sure all unit-tests pass and that there is greater than 90% converage.
make testFeel free to ask a question or start a discussion in the Discussion section of this project.
As mentioned above, there is a dedicated Development section on the wiki.
See the Wiki for more general resources.
The fapolicyd project.
Before submitting an issue:
- A clear title
- Provide as detailed a description as possible and ideally the steps to duplicate the issue.