Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. This project could always use more documentation, whether as part of the README, in docstrings, or even on the web in blog posts articles, and such.
Submmit an issue if you found a bug or have a great idea for a new feature!
Set up for local development:
-
Clone your cookiecutter-toil locally:
git clone git@github.com:papaemmelab/cookiecutter-toil.git
-
Create a branch for local development:
git pull git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
-
Create a test in:
cookiecutter-toil/tests
-
When you're done making changes, run:
pip install -r requirements.txt py.test tests -s
If you need to recreate the tox environments, run:
py.test tests -s --tox-recreate
If you need to test the docker container, run:
py.test tests -s --test-container
-
Commit your changes and push your branch to GitHub (see our
.gitmessage
template):git add . git config commit.template .gitmessage git commit -m ":emoji-name: your short and nice description" git push origin name-of-your-bugfix-or-feature
emoji-name
should be one of the following:emoji name type of change 🚀 rocket new feature 🐛 bug bug fix 📝 memo changes to documentation 🎨 art formatting no code change 🔧 wrench refactoring production code ✅ white_check_mark adding/editing test logic 👕 shirt no production code change 💎 gem bump to new version If you are suggesting a new version make sure you are following the [semantic versioning] guidelines and update the
setup.py
file:git add setup.py git commit -m ":gem: bump to version 0.1.0"
-
Submit a pull request through the GitHub website.