Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/tobiasraabe/cookiecutter-research-template/issues

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement a fix for it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

The cookiecutter could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/tobiasraabe/cookiecutter-research-template/issues.

If you are proposing a new feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up cookiecutter-research-template for local development. Please note this documentation assumes you already have virtualenv and Git installed and ready to go.

Fork the cookiecutter-research-template repo on GitHub.

Clone your fork locally:

$ cd path_for_the_repo
$ git clone git@github.com:YOUR_NAME/cookiecutter-research-template.git

Assuming you have conda installed, you can create a new environment for your local development by typing:
```
$ conda env create -n cc -f environment.yml
```
Install automatic quality checks with pre-commit by running
```
pre-commit install
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass the defined tests.
```
$ tox
```
If your contribution is a bug fix or new feature, you may want to add a test to the existing test suite. See section Add a New Test below for details.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 3.5, 3.6 and 3.7 on Windows, Linux and MacOS. Check the test panel in the pull request and the logs of the test if the tests are failing.

Add a New Test¶

When fixing a bug or adding features, it’s good practice to add a test to demonstrate your fix or new feature behaves as expected. These tests should focus on one tiny bit of functionality and prove changes are correct.

To write and run your new test, follow these steps:

Add the new test to tests/test_cookie.py. Focus your test on the specific bug or a small part of the new feature.
If you have already made changes to the code, stash your changes and confirm all your changes were stashed:
```
$ git stash
$ git stash list
```
Run your test and confirm that your test fails. If your test does not fail, rewrite the test until it fails on the original code:
```
$ pytest
```
(Optional) Run the tests with tox to ensure that the code changes work with different Python versions:
```
$ tox
```
Proceed work on your bug fix or new feature or restore your changes. To restore your stashed changes and confirm their restoration:
```
$ git stash pop
$ git stash list
```
Rerun your test and confirm that your test passes. If it passes, congratulations!