Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

70 lines (45 loc) · 2.48 KB

Contributing

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

Ready to contribute? Here's a quick guide

Contributing website changes

  1. Fork this hackweek's website repo on GitHub.

  2. Clone your fork locally:

    git clone {{website_url}}.git
cd jupyterbook-template

  3. Create a branch to add your changes:

    git checkout -b name-of-your-bugfix-or-feature

  4. Create and activate the "hackweek" conda environment.

    NOTE: If you're running linux or Windows use conda/conda-linux-64.lock

    conda create --name hackweek --file conda/conda-osx-64.lock
conda activate hackweek

    NOTE: If you want to add packages or change the environment, first edit environment.yml in the 'conda' folder, and then generate updated .lock files by executing lock-environment.sh. You can read more about this procedure in this readme.

  5. Make your desired changes and build the book locally

    ./scripts/build_resources.sh

    NOTE: to preview the changes open book/build/html/index.html

  6. Push your branch to GitHub when you're ready:

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

  7. Open a pull request through the GitHub website: {{website_url}}

Contributing tutorials

If you're adding a new Jupyter Notebook Tutorial, please first take a look at our guide on creating tutorials.

When adding a new .ipynb file under book/tutorials be sure to:

  1. Add an entry to the table of contents book/_toc.yml

  2. "Clear all Outputs" before saving. This keeps the book source code small, but outputs are still built for the HTML webpage by Jupyter Book.

Releasing new template versions

Before using this template for events, make a git tag and GitHub Release. We follow a calendar versioning scheme, so tags are a date like 2021.05.05. Don't forget to update the Changelog!