Skip to content

Commit

Permalink
Merge pull request #87 from py-pkgs/patch-contributing-env
Browse files Browse the repository at this point in the history
Added instructions on how to create and activate conda env
  • Loading branch information
ttimbers authored Jan 21, 2025
2 parents 00ca3be + 9bbdec7 commit e6e6202
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions {{ cookiecutter.__package_slug }}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,21 +43,29 @@ If you are proposing a feature:
Ready to contribute? Here's how to set up `{{ cookiecutter.__package_slug }}` for local development.

1. Download a copy of `{{ cookiecutter.__package_slug }}` locally.
2. Install `{{ cookiecutter.__package_slug }}` using `poetry`:

2. Create and activate a conda environment for `{{ cookiecutter.__package_slug }}`:

```console
$ conda create -n {{ cookiecutter.__package_slug }} python={{ cookiecutter.python_version }}
$ conda activate {{ cookiecutter.__package_slug }}
```

3. Install `{{ cookiecutter.__package_slug }}` using `poetry`:

```console
$ poetry install
```

3. Use `git` (or similar) to create a branch for local development and make your changes:
4. Use `git` (or similar) to create a branch for local development and make your changes:

```console
$ git checkout -b name-of-your-bugfix-or-feature
```

4. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.
5. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.

5. Commit your changes and open a pull request.
6. Commit your changes and open a pull request.

## Pull Request Guidelines

Expand Down

0 comments on commit e6e6202

Please # to comment.