Great that you're reading this, because every volunteer is truly welcome to improve this project. This page shall help you to get the needed information on how you can contribute. If you do not find the needed information on this page, just open a new discussion for that topic.
- Did you find a bug?
- Did you write a patch that fixes a bug?
- Do you have questions about the source code?
- Do you intend to add a new feature or change an existing one?
-
Ensure the bug was not already reported, by searching under Issues
-
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title, a clear description, with as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring
-
Open a new pull request with the patch.
-
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
-
If you submit a change to a shell script, check it with ShellCheck first and remove all warnings
- Ask any question about SuricataPi in the Discussions
-
Suggest your change in the Discussions and start writing code.
-
Do not open an issue about the change. GitHub issues are primarily intended for bug reports and fixes.
-
If you have collected positive feedback in the Discussions and finished your work, open a new pull request with the patch.