CONTRIBUTING.md

How to contribute to WFB-ng

Did you find a bug?

• Do not open up a GitHub issue if the bug is a security vulnerability in WFB-ng, and instead to refer to our security policy.

• Ensure the bug was not already reported by searching on GitHub under Issues.

• If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a config file and/or an execution logs demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

• Open a new GitHub pull request with the patch.

• Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

• Before submitting, please format patch according to coding conventions used in wfb-ng sources.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of wfb-ng will generally not be accepted.

Do you intend to add a new feature or change an existing one?

• Suggest your change in the WFB-ng telegram group and start writing code.

• Please don't use any AI instruments for generating code. You should be able to describe every code line during review.

• Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about the source code?

• Ask any question about how to use WFB-ng in the WFB-ng telegram group.