Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING.md to document rye usage #347

Merged
merged 4 commits into from
Sep 12, 2024
Merged

Update CONTRIBUTING.md to document rye usage #347

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c8bd267
Update CONTRIBUTING.md to document rye usage
aron Sep 11, 2024
504da83
Formatting
mattt Sep 11, 2024
1247958
Recommend setup script
mattt Sep 11, 2024
e8128c5
Update URL in setup script
mattt Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@ You can also create a git hook which will sign off all your commits automaticall

First, create the hook file and make it executable:

```sh
```console
cd your/checkout/of/replicate-python
touch .git/hooks/prepare-commit-msg
chmod +x .git/hooks/prepare-commit-msg
```

Then paste the following into the file:

```
```sh
#!/bin/sh

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

## Development

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

```sh
pip install -r requirements-dev.txt
pytest
```console
./script/setup
```

To install the package in development:

```sh
pip install -e .
```
You can run the `format`, `lint`, and `test` scripts before commiting
to validate your changes locally before going through CI.

### Environment variables

Expand Down