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: Update the contribution guide to provide details on how to track the status of changes in the GitHub repo using issues #271

Merged
merged 1 commit into from
Aug 9, 2024
Merged

docs: Update the contribution guide to provide details on how to track the status of changes in the GitHub repo using issues #271

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand All @@ -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 #<issue_number>`
- [ ] 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
Expand Down
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
Loading