Skip to content

Commit

Permalink
Merge pull request #26 from neutrons/add_dev_env_instruction
Browse files Browse the repository at this point in the history
add instructions on how to perform safe editable install
  • Loading branch information
peterfpeterson authored Jul 16, 2024
2 parents 6935aea + ec61186 commit 2a3c777
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,3 +143,12 @@ index-servers = pypi, testpypi
### Instruction for publish to Anaconda

Publishing to Anaconda is handled via workflow, `package.yml`.

Development environment setup
-----------------------------

### Build development environment

1. By default, we recommend providing a single `environment.yml` that covers all necessary packages for development.
2. The runtime dependency should be in `meta.yaml` for anaconda packaging, and `pyproject.toml` for PyPI publishing.
3. When performing editable install for your feature branch, make sure to use `pip install --no-deps -e .` to ensure that `pip` does not install additional packages from `pyproject.toml` into development environment by accident.

0 comments on commit 2a3c777

Please sign in to comment.