pf
How to contribute to pf

<strong>Contribute a fully-worked example!</strong>

  • 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!

<strong>Did you find a bug?</strong>

  • 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.

<strong>Did you fix a bug?</strong>

  • 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.

<strong>Do you intend to add a new feature or change an existing one?</strong>

  • Suggest your change by opening up an issue, and labeling it as an "enhancement."
  • Open a new GitHub pull request with the enhancement.

<strong>Do you have questions about the source code or how to incorporate <tt>pf</tt> into your project?</strong>

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

<strong>Do you want to contribute to the documentation?</strong>

  • 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!