Thanks for taking the time to contribute!
The following are a set of guidelines for contributing to Bisl.
Bisl is built on Django and uses docker and docker-compose to run the project in every environment it is run, as well as for tests.
If you are familiar with these tools you shouldn't have any problem running, testing, and contributing to the project.
Please read all of the docs in the project before contributing.
After you've read over the docs, you can look through the issues tagged with "good first issue" in the project.
If you encounter a bug or would like to suggest enhancements, please open a new issue
Provide as much detail as you are able when opening new issues.
The product road map can be found in the project board
Pull Requests are always welcome.
- Pull requests must have a passing build (passing tests, and linter) to be approved
- Ensure the PR description clearly describes the problem and solution. It should include:
- A summary of the changes being proposed
- An estimated priority (low/medium/high)
- An appropriate tag (bugfix, enhancement)
- A description of smoke testing procedure one could follow
- A reference Issue that is being addressed. If one doesn't exist, add one first