Skip to content

Commit 094f8b5

Browse files
committed
Better text
1 parent 970c17d commit 094f8b5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ The sections below outline the steps in each case.
3131
1. (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
3232
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
3333
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
34-
1. clone the [protein-quest](https://github.com/haddocking/protein-quest) repository into the parent directory (one level up from protein-detective) as protein-detective depends on it in editable/development mode:
34+
1. clone the [protein-quest](https://github.com/haddocking/protein-quest) repository into the parent directory (one level up from protein-detective), since protein-detective depends on it during development:
3535
```shell
3636
cd ..
3737
git clone git@github.com:haddocking/protein-quest.git
3838
cd protein-detective
3939
```
40-
Note: Since protein-quest is installed in editable mode, any changes you make to its code will be immediately available in protein-detective without requiring a reinstall.
40+
Since protein-quest is installed as a [source dependency](https://docs.astral.sh/uv/concepts/projects/dependencies/#dependency-sources), any changes you make to its code will be immediately available in protein-detective without needing to reinstall it.
4141
1. install [uv](https://docs.astral.sh/uv) to manage this packages development environment);
4242
1. Make sure `uv sync && . .venv/bin/activate && protein-detective --help` works;
4343
1. make sure the existing tests still work by running `uv run pytest`;

0 commit comments

Comments
 (0)