From be304ceea1c49449af752eac81187b783088eb21 Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Fri, 28 Jul 2023 09:05:01 +0200 Subject: [PATCH] Also updating installation instructions on contributing.md --- docs/contributing.md | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index bdfddcc74..26490e0b1 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -5,21 +5,12 @@ Even if you don't want to contribute directly to the codebase, getting involved This document outlines some guidelines for contributing to the parcels codebase. If you have any questions or suggestions for how we can improve this document, please let us know. -## Getting Started - -To get started contributing to parcels, you'll need to do a few things: - -1. [Fork our repository](https://github.com/OceanParcels/parcels/fork) on GitHub. -2. Clone your fork of the repository to your local machine, and `cd` into your project folder. - -3. Install [Anaconda](https://www.anaconda.com/download) (if you haven't already). - -4. Install the development Anaconda environment by installing from the environment file corresponding to your OS (`environment_py3_linux.yml`, `environment_py3_osx.yml` or `environment_py3_win.yml`) then activate it. E.g. on Linux: `conda env create -f environment_py3_linux.yml` then `conda activate py3_parcels`. +## Getting Started -5. Install your local copy of parcels in editable mode by running `pip install -e .`. +To get started contributing to parcels, you'll need to install the developer version of Parcels following [the instructions](installation#installation-for-developers). This will install the latest version of Parcels from the `master` branch of the repository. -6. **Optional:** Setup `pre-commit` hooks by running `pre-commit install`. This ensures that code is formatted correctly before you commit it. +**Optional:** Setup `pre-commit` hooks by running `pre-commit install`. This ensures that code is formatted correctly before you commit it. ## Making Changes