Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs as a GitHub issue.
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.
If you are proposing a feature, please include:
- 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 :)
Look through the (https://github.com/executablebooks/cookiecutter-jupyter-book/issues) for bugs, feature requests, etc and feel free to contribute!
Ready to contribute? Here's how to set up cookiecutter-jupyter-book for local development.
- Fork the
cookiecutter-jupyter-bookrepo on GitHub. - Clone your fork locally and install requirements:
git clone git@github.com:your_name_here/cookiecutter-jupyter-book.git
pip install -r requirements.txt- Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature- Make your desired changes, run tests, and push your branch to GitHub when you're ready:
pytest
black ./ --check
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature- Open a pull request through the GitHub website. Naming convention for pull requests is detailed here. For example, a pull request that adds a new feature might be titled:
✨ NEW: validate entered github username.