Skip to main content

Participation Guidelines

Thank you for taking the time to participate. Contributions from individuals like yourself help to make pywhlobf an excellent tool to use.

This document provides guidelines for contributing code and documentation to pywhlobf. Following these guidelines makes it easier for the maintainers to respond to your pull requests and provide timely and helpful feedback to help you finalize your requested changes.

Types of Participations​

You can contribute to pywhlobf by submitting bug reports and feature requests, or by writing code to do any of the following:

  • Fix a bug.
  • Improve a current feature.
  • Implement a planned feature.

We also welcome contributions to the documentation!

Contributor Guidelines​

We value input from each member of the community, and we ask that you follow our code of conduct. We are a small team, but we try to respond to issues and pull requests within 3 business days.

Before you start​

For changes that you contribute to the repository, please do the following:

  • Create issues for any major changes and enhancements that you want to make.
  • Keep pull requests specific to one issue. Shorter pull requests are preferred and are easier to review.

Code standards​

Follow these code formatting guidelines:

Testing​

  • Make sure that changes you make work on Windows, Mac, and Linux operating systems.
  • Include unit tests when you contribute bug fixes and new features. Unit tests help prove that your code works correctly and protects against future breaking changes.
  • Make sure that the code coverage checks and automatic tests for pull requests pass.

Additional questions​

If you have any further inquiries that have not been addressed in these guidelines, please do not hesitate to open an issue on the GitHub page to initiate a discussion.