Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.92 KB
Raw

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

To build our website, we need specific Python packages which are managed with the conda and mamba tools. If you already do not already have those tools installed, we recommend using the Mambaforge Installer:

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

  2. Clone your fork locally:

    git clone https://github.com/geo-smart/use_case_template.git
cd book

  3. Create a branch to add your changes:

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

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

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

    mamba env create --name geosmart --file conda/conda-osx-64.lock.yml
mamba activate geosmart

    NOTE: If you want to add packages or change the environment, you must follow the procedure outlined in ./conda/README.md.

  5. Make your desired changes and build the book locally

    jb build book

    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: https://github.com/geo-smart/use_case_template