Skip to content

Update documents #197

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

Merged
Preocts merged 1 commit into from
May 31, 2025
Merged

Update documents #197

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The following steps outline how to install this repo for local development.

### Clone repo

```console
```bash
git clone https://github.com/[ORG NAME]/[REPO NAME]

cd [REPO NAME]
Expand All @@ -71,19 +71,19 @@ nox -s dev

### Run tests with coverage

```console
```bash
nox -s test
```

### Run formatters and linters

```console
```bash
nox -s lint
```

### Build dist

```console
```bash
nox -s build
```

Expand All @@ -100,13 +100,13 @@ Once updated following the steps below, the package can be installed if needed.

### Update the generated files with changes

```console
```bash
nox -s update-deps
```

### Upgrade all generated dependencies

```console
```bash
nox -s upgrade-deps
```

Expand Down