From fd21569919c95abff1ef747d89fe513042281ee5 Mon Sep 17 00:00:00 2001 From: Junior Gantin Date: Fri, 12 Jul 2019 05:30:56 +0100 Subject: [PATCH] update readme --- CONTRIBUTING.md | 21 +++++++++++++++++++++ readme.md | 5 ++++- 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7868d1b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +All contributions are welcomed. If it's your first time contributing to open source please don't hesitate and just open a Pull Request. Your suggestion/fix isn't stupid, I'll make sure I explain what's wrong with your PR if it wasn't accepted. + +## Here are some points to consider: + +- Your PR must be making only a single change, if you want to suggest multiple features or fix multiple issues please open separate PRs. +- If you have an idea that will require a lot of work, make sure you suggest it in a new [issue](https://github.com/PythonBenin/kkiapay-python/issues) first to make sure it's admired before investing time into it. +- If you want to contribute and not sure where to start, check the [road map](https://github.com/PythonBenin/kkiapay-python#road-map). +- Pull Requests that don't have a clear explanation of what it does will be closed. Sorry :) +- Keep your code clean. Clean means you're proud of how it turned out. + +## How to contribute: + +Clone `kkiapay-python` on your machine. Install all development dependencies using: + +```bash +pipenv install --dev +``` +If you haven't used `pipenv` before but are comfortable with virtualenvs, just run `pip install pipenv` in the virtualenv you're already using and invoke the command above from the cloned `kkiapay-python` repo. It will do the correct thing. + diff --git a/readme.md b/readme.md index 3971481..6de53c6 100644 --- a/readme.md +++ b/readme.md @@ -56,7 +56,10 @@ print(transaction.amount) Here's the plan for what's coming: -- [x] Python 2 +- [x] Sandbox and Live environments +- [x] Verify Transaction +- [ ] Refund Transaction +- [ ] Schedule Payout - [ ] Add tests. ## Contributing