Contribution Guidelines

Pacu Contributions

Used Pacu and found something that could be improved? You're in luck! Contributions to Pacu are greatly appreciated.

Pacu is still in its early stages, and bug reports are essential to improving the project. Please submit it via Pacu's issue tracker.

If you'd like to help make Pacu itself better than ever by submitting a pull request, read on.

Python code in Pacu should generally follow Python's style conventions, favoring readability and maintainability above all.
- flake8, a Python syntax and style linter, is a development dependency for Pacu, and its notifications should mostly be resolved before code contributions are accepted. A .flake8 configuration file is included with Pacu and contains a small number of specific rules that flake8 will ignore during Pacu's early development, but which may or may not eventually be removed. Use good judgment (or even a code formatter, if you like!) when making code style decisions.
Use descriptive commit messages. Shorter is usually, but not always, better. Consider the 50/72 rule when writing commit messages.
Pacu code should always use the BSD 3-clause license.

Pull requests should be targeted at the master branch.
Use a descriptive title.
Write a description, and reference related issues in the description, as applicable.
Respond to comments on pull requests, don't fire and forget.

Report vulnerabilities in Pacu directly to us via email: [email protected].
If you have a feature request, an idea, or a bug to report, please submit them here. Please include a description sufficient to reproduce the bug you found, including tracebacks and reproduction steps, and check for other reports of your bug before filing a new bug report. Don't submit duplicates.