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

docs: Added instructions on how to set up commit signing with a note explaining that it is required. #78

Merged
merged 2 commits into from
Oct 28, 2023
Merged

docs: Added instructions on how to set up commit signing with a note explaining that it is required. #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93fe9c2
docs: Added instructions on how to set up commit signing with a note …
nfelt14 Oct 28, 2023
afb1ff6
fix: Update path for documentation publishing workflow to point to th…
nfelt14 Oct 28, 2023
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
4 changes: 2 additions & 2 deletions .github/workflows/deploy-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ jobs:
- name: Unzip Documentation Results
run: |
unzip docs_results.zip
rm -r docs_results/.results_docs/html/.doctrees
nfelt14 marked this conversation as resolved.
Show resolved Hide resolved
rm -r .results_docs/html/.doctrees
- name: Upload To Pages
uses: actions/upload-pages-artifact@v2
with:
path: docs_results/.results_docs/html
path: .results_docs/html
- name: Deploy To Pages
uses: actions/deploy-pages@v2
id: deployment
19 changes: 13 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
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