From ce1d94b5ae8631b4eef42c275e8d83f63a7466ed Mon Sep 17 00:00:00 2001 From: "Felt, Nicholas" Date: Wed, 7 Aug 2024 15:59:55 -0700 Subject: [PATCH] docs: Update the contribution guide to provide details on how to track the status of changes in the GitHub repo using issues --- .github/PULL_REQUEST_TEMPLATE.md | 3 +++ CONTRIBUTING.md | 12 ++++++++---- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d412bf6d..8d4d7d26 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,6 +2,8 @@ Please include a summary of the changes and any links to related issues. Please also include relevant motivation and context. +Addresses #\< fill in issue number here > + ## Types of changes What types of changes does your code introduce? @@ -21,6 +23,7 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating - [ ] I have followed the guidelines in the [CONTRIBUTING](https://github.com/tektronix/tm_devices/blob/main/CONTRIBUTING.md) document - [ ] I have signed the CLA - [ ] I have checked to ensure there aren't other open [Pull Requests](https://github.com/tektronix/tm_devices/pulls) for the same update/change +- [ ] I have created (or updated) an [Issue](https://github.com/tektronix/tm_devices/issues) to track the status of this update/change and updated the link in this PR description (see above in the **Proposed changes** section) using the wording `Addresses #` - [ ] I have performed a self-review of my code - [ ] My code follows the style guidelines of this project - [ ] I have commented my code, particularly in hard-to-understand areas diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8894249..fc5bf474 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,15 +88,19 @@ Ready to contribute? Here's how to set up `tm_devices` for local development. pre-commit install ``` -4. Use `git` to create a branch for local development and make your changes: +4. Check to see if there are any [open issues](https://github.com/tektronix/tm_devices/issues) or [pull requests](https://github.com/tektronix/tm_devices/pulls) that are related to the change you wish to make. + +5. Create or update an [issue](https://github.com/tektronix/tm_devices/issues) to track the status of your change. + +6. Use `git` to create a branch for local development and make your changes: ```console git checkout -b name-of-your-bugfix-or-feature ``` -5. Update the **Unreleased** section in the [CHANGELOG](./CHANGELOG.md) using the proper format. +7. Update the **Unreleased** section in the [CHANGELOG](./CHANGELOG.md) using the proper format. -6. When you're done making changes, check that your changes conform to any code +8. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests. !!! note @@ -159,7 +163,7 @@ Ready to contribute? Here's how to set up `tm_devices` for local development. python -m http.server -d .results_docs ``` -7. Commit and push your changes, then open a pull request from +9. 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: