Skip to content

Commit

Permalink
Policy change: Document change logs directly in PRs.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed May 20, 2024
1 parent 9fc79db commit baf7252
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 9 deletions.
8 changes: 1 addition & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,9 @@ Resolves #???

<!--- Please describe how you tested your changes. -->

## Change log

<!-- Propose a change log entry. -->
```
```

## Checklist:

- [ ] I have reviewed the [**Contributor Guidelines**](https://github.com/glotzerlab/row/blob/trunk/doc/src/developers/contributing.md).
- [ ] I agree with the terms of the [**Row Contributor Agreement**](https://github.com/glotzerlab/row/blob/trunk/ContributorAgreement.md).
- [ ] My name is on the list of contributors (`doc/src/contributors.md`) in the pull request source branch.
- [ ] I have added a change log entry to `doc/src/release-notes.md`.
4 changes: 2 additions & 2 deletions doc/src/developers/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,6 @@ When applicable, update or write a new tutorial or how-to guide.
Update the contributors documentation to name each developer that has contributed to the
code.

### Propose a change log entry
### Add a change log entry

Propose a short concise entry describing the change in the pull request description.
Add a short concise entry describing the change in `doc/src/release-notes.md`.

0 comments on commit baf7252

Please sign in to comment.