Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.5 KB

Contributing to ProbeQuest

ProbeQuest is a free and open-source software, which means that you can contribute to its improvement. The following document is a set of guidelines to help you in this process. Thank you for taking the time to read it!

Types of Contributions

Issues

Several templates are available when creating a new issue:

  • Bug report
  • Feature request
  • Report a security vulnerability

Please select the appropriate one and follow the instructions. Also, make sure to:

  • Check for duplicates before creating your issue
  • Choose a descriptive title

If you want to ask a question, please open a new discussion instead of a new issue.

Pull Requests

ProbeQuest follows the gitflow branching model, which means that your pull request needs to target the develop branch.

When introducing new code to ProbeQuest, please make sure to add the appropriate tests and documentation that cover your changes.

Development Environment

To set up your development environment, please read the "Development" section of ProbeQuest's documentation.