1
0
Fork 0
mirror of https://github.com/pivpn/pivpn.git synced 2024-12-23 13:20:16 +00:00
pivpn/CONTRIBUTING.md

33 lines
1.3 KiB
Markdown

## How to contribute to PiVPN
### **Before Getting Started**
#### Code of Conduct
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.
Please report unacceptable behavior to any project maintainer.
### Contributing
#### **Did you find a bug?**
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/pivpn/pivpn/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/pivpn/pivpn/issues/new). 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.
#### **Do you want to open a pull request to modify the source?**
* Open a new GitHub pull request with the patch on the [test](https://github.com/pivpn/pivpn/tree/test) branch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
### **PiVPN Website**
* Yes the site is open source as well! You can find and contribute to [pivpn.io](https://github.com/pivpn/pivpn.io) directly.
</br>
Thanks!
PiVPN Team