Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (22 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

44 lines (22 loc) · 1.77 KB
Raw

Contributing

Thank you for investing your time in contributing to our project!

When contributing to this repository, please first discuss the change you wish to make via issue, email (to: belza@fing.edu.uy), or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

How to contribute to PyWiCh

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

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

  • Suggest your change in a new issue or by email to belza@fing.edu.uy before start writing code.

Pull Request Process

  1. Update the README.md with details of changes.
  2. Increase the version numbers in the README.md to the new version that this Pull Request would represent.

Do you have questions about the source code?

  • Ask any questions about how to use PyWich or about the source code of PyWiCh to belza@fing.edu.uy

You can also contribute to PyWiCh documentation!!!

Thanks!