Skip to content

Latest commit

 

History

History
41 lines (21 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

41 lines (21 loc) · 1.96 KB
Raw

How to contribute to pf

Contribute a fully-worked example!

  • send us a link to a Github repository with a self-contained example, and after we're able to build the project, we'll be sure to link to it in this project's README!

Did you find a bug?

  • 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 and label it as a "bug."

  • Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you fix 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.

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

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

  • Suggest your change by opening up an issue, and labeling it as an "enhancement."

  • Open a new GitHub pull request with the enhancement.

Do you have questions about the source code or how to incorporate pf into your project?

  • Ask any question you have by opening up an issue, and labeling it as a "question."

Do you want to contribute to the documentation?

  • Awesome! Documentation is automatically generated with Doxygen. Please peruse that site to get tips on how to write the specially formatted comments.

  • Running doxygen Doxyfile will generate all files in docs/

  • Submit a pull request when you're finished.

Thanks!