From 5e70bc671449e9f4da080ea45e885a4951f3ed8e Mon Sep 17 00:00:00 2001 From: Ross Beyer Date: Tue, 2 Jul 2024 16:45:58 -0700 Subject: [PATCH] docs(CONRIBUTING): Minor wording changes. --- CONTRIBUTING.rst | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index dc111b3..6eea187 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -65,40 +65,37 @@ Ready to contribute? Here's how to set up `synthterrain` for local development. 1. Fork the `synthterrain` repo on GitHub. 2. Clone your fork locally:: - $ git clone git@github.com:your_name_here/synthterrain.git + $> git clone git@github.com:your_name_here/synthterrain.git 3. Install your local copy into a virtual environment of your choice (there are many to choose from like conda, etc.). We will assume conda here, but any should work:: - $ cd synthterrain/ - $ conda env create -n synthterrain - $ conda activate synthterrain - $ mamba env update --file environment_dev.yml - $ mamba env update --file environment.yml - $ pip install opensimplex - $ pip install --no-deps -e . + $> cd synthterrain/ + $> conda env create -n synthterrain + $> conda activate synthterrain + $> mamba env update --file environment_dev.yml + $> mamba env update --file environment.yml + $> pip install --no-deps -e . The last ``pip install`` installs synthterrain in "editable" mode which facilitates using the programs and testing. 4. Create a branch for local development:: - $ git checkout -b name-of-your-bugfix-or-feature + $> git checkout -b name-of-your-bugfix-or-feature Now you can make your changes locally. 5. When you're done making changes, check that your changes pass flake8 and the - tests, including testing other Python versions with tox:: + tests. - $ flake8 src/synthterrain tests - $ python setup.py test or pytest - $ tox + $> make lint + $> make test - To get flake8 and tox, just pip install them into your virtual environment. 6. 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 + $> git add . + $> git commit -m "Your detailed description of your changes." + $> git push origin name-of-your-bugfix-or-feature 7. Submit a pull request through the GitHub website.