Skip to content

Commit e051739

Browse files
aronmattt
andauthored
Update CONTRIBUTING.md to document rye usage (#347)
Signed-off-by: Mattt Zmuda <[email protected]> Co-authored-by: Mattt Zmuda <[email protected]>
1 parent 0043199 commit e051739

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ You can also create a git hook which will sign off all your commits automaticall
5555

5656
First, create the hook file and make it executable:
5757

58-
```sh
58+
```console
5959
cd your/checkout/of/replicate-python
6060
touch .git/hooks/prepare-commit-msg
6161
chmod +x .git/hooks/prepare-commit-msg
6262
```
6363

6464
Then paste the following into the file:
6565

66-
```
66+
```sh
6767
#!/bin/sh
6868

6969
NAME=$(git config user.name)
@@ -86,18 +86,15 @@ git interpret-trailers --if-exists doNothing --trailer \
8686

8787
## Development
8888

89-
To run the tests:
89+
The Python project is managed using [`rye`](https://rye.astral.sh).
90+
Run the setup script to install Rye and install the project's dependencies.
9091

91-
```sh
92-
pip install -r requirements-dev.txt
93-
pytest
92+
```console
93+
./script/setup
9494
```
9595

96-
To install the package in development:
97-
98-
```sh
99-
pip install -e .
100-
```
96+
You can run the `format`, `lint`, and `test` scripts before commiting
97+
to validate your changes locally before going through CI.
10198

10299
### Environment variables
103100

script/setup

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ then
1414
case "$REPLY" in
1515
[yY])
1616
echo "Installing rye..."
17-
curl -sSf https://rye-up.com/get | sh
17+
curl -sSf https://rye.astral.sh/get | sh
1818
echo "rye has been successfully installed."
1919
;;
2020
*)

0 commit comments

Comments
 (0)