Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions
Report bugs at https://github.com/opencybersecurityalliance/firepit/issues.
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
firepit could always use more documentation, whether as part of the official firepit docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/opencybersecurityalliance/firepit/issues.
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here’s how to set up firepit for local development.
Fork the firepit repo on GitHub.
Clone your fork locally:
$ git clone firstname.lastname@example.org:your_name_here/firepit.git
Install your local copy into a virtualenv. Assuming you have pyenv installed, this is how you set up your fork for local development:
$ cd firepit/ $ pyenv virtualenv python-3.9.2 firepit $ pyenv local firepit $ make setup
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass linting and the tests (this will be done automatically with a git pre-commit hook):
$ make lint $ make test
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Request a review from one of the maintainers.
Pull Request Guidelines
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 3.8, 3.9, 3.10, and 3.11. There is a GitHub workflow that will check for this automatically.
All contributions must be covered by a Contributor’s License Agreement (CLA) and Entity CLA (if you are contributing on behalf of your employer). You will get a prompt to sign CLA when you submit your first PR.
To run a subset of tests:
$ pytest tests/test_storage.py
$ pytest -k test_something...
A reminder for the maintainers on how to release. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ bump2version patch # possible: major / minor / patch $ git push $ git push --tags