Skip to content

Commit

Permalink
docs: Added instructions on how to set up commit signing with a note …
Browse files Browse the repository at this point in the history
…explaining that it is required.
  • Loading branch information
nfelt14 committed Oct 28, 2023
1 parent 7ab18d3 commit 93fe9c2
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,16 @@ recommended IDE for package development is

### Setup steps for package development

1. Fork `tm_devices` into a new repository.
1. Set up commit signing, see [GitHub's documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) for details.

2. Set up a virtual environment and install the project with its dependencies:
```{hint}
All commits going into the main repository are required to be signed, so make sure
to set up commit signing before starting to make changes.
```

2. Fork `tm_devices` into a new repository.

3. Set up a virtual environment and install the project with its dependencies:

- Using the helper script (recommended):
```console
Expand All @@ -91,15 +98,15 @@ recommended IDE for package development is
pre-commit install
```

3. Use `git` to create a branch for local development and make your changes:
4. Use `git` to create a branch for local development and make your changes:

```console
git checkout -b name-of-your-bugfix-or-feature
```

4. Update the **Unreleased** section in the [CHANGELOG](CHANGELOG.md) using the proper format.
5. Update the **Unreleased** section in the [CHANGELOG](CHANGELOG.md) using the proper format.

5. When you're done making changes, check that your changes conform to any code
6. When you're done making changes, check that your changes conform to any code
formatting requirements and pass any tests.

````{note}
Expand Down Expand Up @@ -145,7 +152,7 @@ recommended IDE for package development is
- Test results: `.results_tests/results.html`
```

6. Commit and push your changes, then open a pull request from
7. Commit and push your changes, then open a pull request from
the fork back into the main repository.

- Commit messages must be structured as follows:
Expand Down

0 comments on commit 93fe9c2

Please sign in to comment.