CONTRIBUTING.md 1.47 KB
Newer Older
Radek Sprta's avatar
Radek Sprta committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
# How to contribute to Vigil

## **Did you find a bug?**

* **Ensure the bug was not already reported** by searching on Gitlab under [Issues](https://gitlab.com/radek-sprta/vigil/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://gitlab.com/radek-sprta/vigil/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.

## **Did you write a patch that fixes a bug?**

* Open a new Gitlab merge request with the patch.

* Ensure the description clearly describes the problem and solution. Include the relevant issue number if applicable.

* Before submitting, please read the [Pep 8](https://www.python.org/dev/peps/pep-0008/) and [Pep 257](https://www.python.org/dev/peps/pep-0257/) guide to know more a out coding conventions.
* Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug." This convention matches up with commit messages generated by commands like git merge and git revert.

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

* [Open a new issue](https://gitlab.com/radek-sprta/vigil/issues/new). Do not start coding until you have collected positive feedback about the change.

## **Do you want to contribute to the Vigil documentation?**

* Update the documentation and send the merge request.

Thanks!

Radek Sprta
Maintainer