Briq
/
camelot-py
6
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added a line to install dependencies

pull/78/head
sidntrivedi012 2019-10-14 13:21:16 +05:30
parent 7ecfcad239
commit 72d71ceca0
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -1,6 +1,6 @@
# Contributor's Guide # Contributor's Guide
If you're reading this, you're probably looking to contributing to Camelot. *Time is the only real currency*, and the fact that you're considering spending some here is *very* generous of you. Thank you very much! If you're reading this, you're probably looking to contributing to Camelot. _Time is the only real currency_, and the fact that you're considering spending some here is _very_ generous of you. Thank you very much!
This document will help you get started with contributing documentation, code, testing and filing issues. If you have any questions, feel free to reach out to [Vinayak Mehta](https://vinayak-mehta.github.io), the author and maintainer. This document will help you get started with contributing documentation, code, testing and filing issues. If you have any questions, feel free to reach out to [Vinayak Mehta](https://vinayak-mehta.github.io), the author and maintainer.
@ -20,6 +20,8 @@ A great way to start contributing to Camelot is to pick an issue tagged with the
## Setting up a development environment ## Setting up a development environment
Firstly, install [tk](https://packages.ubuntu.com/bionic/python/python-tk) and [Ghostscript](https://www.ghostscript.com/).
To install the dependencies needed for development, you can use pip: To install the dependencies needed for development, you can use pip:
<pre> <pre>
@ -80,6 +82,7 @@ We recommend that your pull request complies with the following rules:
- In case your pull request contains function docstrings, make sure you follow the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) format. All function docstrings in Camelot follow this format. Moreover, following the format will make sure that the API documentation is generated flawlessly. - In case your pull request contains function docstrings, make sure you follow the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) format. All function docstrings in Camelot follow this format. Moreover, following the format will make sure that the API documentation is generated flawlessly.
- Make sure your commit messages follow [the seven rules of a great git commit message](https://chris.beams.io/posts/git-commit/): - Make sure your commit messages follow [the seven rules of a great git commit message](https://chris.beams.io/posts/git-commit/):
- Separate subject from body with a blank line - Separate subject from body with a blank line
- Limit the subject line to 50 characters - Limit the subject line to 50 characters
- Capitalize the subject line - Capitalize the subject line