Commit 1900b039 authored by Radek Sprta's avatar Radek Sprta

Add contributing guide

parent 630fb6aa
# 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
# 0.3
* add contribution guide
* completely automate documentation
* integrate build with tox
* add pypy tests
* automatically build stable snaps for releases
* make a pypi package
......
../CONTRIBUTING.md
\ No newline at end of file
......@@ -4,6 +4,7 @@ pages:
- Installation: install.md
- Configuration: config.md
- Usage: use.md
- Contributing: contributing.md
- License: license.md
repo_url: https://gitlab.com/radek-sprta/vigil
site_author: Radek Sprta
......@@ -39,6 +39,9 @@ class WatchCollection:
@property
def templates(self):
"""
Jinja template environment.
"""
env = jinja2.Environment(
loader=jinja2.PackageLoader('vigil', 'templates'),
autoescape=jinja2.select_autoescape(['html', 'xml']))
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment