Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jdidion committed Jul 9, 2017
1 parent d137fbe commit c146fcf
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
We welcome any contributions via pull requests. We are especially interested in a collaborator that would either backport xphyle to Python 2.x or implement a compatibility layer to my xphyle Python version-independent.

All code must be written in idiomatic python 3. Note that we use [PEP484](https://www.python.org/dev/peps/pep-0484/) type hints. Variable annotations are
defined where needed using the comment syntax. Static code analysis is performed usying [mypy](http://mypy-lang.org/) and pylint.

Style-wise, we try to adhere to the Google python style guidelines. We use Google-style docstrings, which are formatted by the [Napoleon Sphinx Plugin](https://pypi.python.org/pypi/sphinxcontrib-napoleon).

We enforce the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.

0 comments on commit c146fcf

Please sign in to comment.