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.

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

Allow PR template to catch incomplete tasks #686

Merged
merged 24 commits into from
Mar 11, 2022
Merged
Changes from 22 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
e193672
Allow PR template to catch incomplete tasks
cbkerr Feb 22, 2022
0eca260
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 22, 2022
b30fa26
Move request to create label to comment
cbkerr Feb 22, 2022
320d695
Add request to mark breaking
cbkerr Feb 26, 2022
2596d03
Add guidance on updating framework docs
cbkerr Feb 26, 2022
6e2b0ca
Fix template github link to docs
cbkerr Feb 26, 2022
cee5dbd
Merge branch 'master' into fix/update-pr-template
cbkerr Feb 26, 2022
72dfceb
Shorten headline
cbkerr Mar 1, 2022
a1c85d6
Use 2 line breaks per empty section
cbkerr Mar 1, 2022
944bb16
Shorten checklist items in response to code review
cbkerr Mar 1, 2022
0da3bb3
Clarify wording
cbkerr Mar 4, 2022
8e5ef2e
Remove if applicable from changelog checklist
cbkerr Mar 4, 2022
862d722
Improve wording - requiring checklist for merging but not reviewing
cbkerr Mar 4, 2022
40a6be6
Update direction on breaking changes
cbkerr Mar 4, 2022
96672bc
Remove redundant code style item
cbkerr Mar 4, 2022
d40ddc8
Apply suggestions from code review
cbkerr Mar 4, 2022
9203df6
Remove reference to breaking label
cbkerr Mar 4, 2022
72d1f8f
Merge branch 'master' into fix/update-pr-template
cbkerr Mar 9, 2022
18f9a54
Simplify reminder to update docs
cbkerr Mar 9, 2022
394e694
Try using a file relative link
cbkerr Mar 9, 2022
061bd68
Fix relative link to package docs
cbkerr Mar 9, 2022
68c0137
Make bold emphasize important non-link word
cbkerr Mar 9, 2022
2e15982
Update .github/PULL_REQUEST_TEMPLATE.md
cbkerr Mar 9, 2022
055f7c7
Update .github/PULL_REQUEST_TEMPLATE.md
cbkerr Mar 9, 2022
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
29 changes: 8 additions & 21 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,20 @@
<!-- Provide a general summary of your changes in the Title above -->

## Description
<!-- Describe your changes in detail -->
<!-- Describe your changes in detail. -->
<!-- Please indicate if the changes may break existing functionality. -->

## Motivation and Context
<!-- Why is this change required? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here. -->

## Types of Changes
<!-- Please select all items that apply either now or after creating the pull request: -->
- [ ] Documentation update
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change<sup>1</sup>

<sup>1</sup>The change breaks (or has the potential to break) existing functionality.

## Checklist:
<!-- Please select all items that apply either now or after creating the pull request. -->
<!-- This checklist must be complete before merging the pull request. -->
<!-- If you are unsure about any of these items, do not hesitate to ask! -->
- [ ] I am familiar with the [**Contributing Guidelines**](https://github.com/glotzerlab/signac/blob/master/CONTRIBUTING.md).
- [ ] I agree with the terms of the [**Contributor Agreement**](https://github.com/glotzerlab/signac/blob/master/ContributorAgreement.md).
- [ ] I am familiar with the [Contributing Guidelines](https://github.com/glotzerlab/signac/blob/master/CONTRIBUTING.md).
- [ ] I agree with the terms of the [Contributor Agreement](https://github.com/glotzerlab/signac/blob/master/ContributorAgreement.md).
- [ ] My name is on the [list of contributors](https://github.com/glotzerlab/signac/blob/master/contributors.yaml).
- [ ] My code follows the [code style guideline](https://github.com/glotzerlab/signac/blob/master/CONTRIBUTING.md#code-style) of this project.
- [ ] The changes introduced by this pull request are covered by existing or newly introduced tests.

If necessary:
- [ ] I have updated the API documentation as part of the package doc-strings.
- [ ] I have created a separate pull request to update the [framework documentation](https://docs.signac.io/) on [signac-docs](https://github.com/glotzerlab/signac-docs) and linked it here.
- [ ] I have updated the [changelog](https://github.com/glotzerlab/signac/blob/master/changelog.txt) and added all related issue and pull request numbers for future reference (if applicable). See example below.

<!-- Example for a changelog entry: `Fix issue with launching rockets to the moon (#101, #212).` -->
- [ ] The changes introduced by this pull request are covered by existing or newly introduced **tests**.
cbkerr marked this conversation as resolved.
Show resolved Hide resolved
- [ ] The [package documentation](../tree/master/doc) and [framework documentation](https://docs.signac.io/) in [signac-docs](https://github.com/glotzerlab/signac-docs) are up to date with these changes.
cbkerr marked this conversation as resolved.
Show resolved Hide resolved
- [ ] I have updated the [changelog](https://github.com/glotzerlab/signac/blob/master/changelog.txt) and added any related issue and pull request numbers for future reference.