From 554d75b4f8f429d4c7a1e0722e90518c67d695bf Mon Sep 17 00:00:00 2001 From: Nicholas Felt Date: Fri, 27 Oct 2023 22:06:12 -0700 Subject: [PATCH] Update contribution guide and documentation publishing workflow (#78) * docs: Added instructions on how to set up commit signing with a note explaining that it is required. * fix: Update path for documentation publishing workflow to point to the correct folder after unzipping the artifact. --- .github/workflows/deploy-documentation.yml | 4 ++-- CONTRIBUTING.md | 19 +++++++++++++------ 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/.github/workflows/deploy-documentation.yml b/.github/workflows/deploy-documentation.yml index e2b7507b..06f443c3 100644 --- a/.github/workflows/deploy-documentation.yml +++ b/.github/workflows/deploy-documentation.yml @@ -29,11 +29,11 @@ jobs: - name: Unzip Documentation Results run: | unzip docs_results.zip - rm -r docs_results/.results_docs/html/.doctrees + 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2bb5a5a5..e9b440a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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} @@ -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: