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

Pr template update #655

Merged
merged 3 commits into from
Jun 28, 2022
Merged

Pr template update #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54e2456
Add backward-compatiblity and dependency questions to PR template
am357 Jun 28, 2022
8c1f2ef
Add unreleased changes
am357 Jun 28, 2022
7a65912
Update .github/PULL_REQUEST_TEMPLATE.md
am357 Jun 28, 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
13 changes: 12 additions & 1 deletion .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,17 @@

*Description of changes:*

*Have you updated the `Unreleased` section of `CHANGELOG.md` with your changes? (y/n) If not, please explain why:*
*Have you updated the `Unreleased` section of `CHANGELOG.md` with your changes? (y/n), If not, please explain why:*

*Does your PR include any backward-incompatible changes? (y/n), if yes, please explain the reason. In addition, please
also mention any other alternatives you've considered and the reason they've been discarded?:*

```
For this purpose, we define backward-incompatible changes as changes that—when consumed—can potentially result in
errors for users that are using our public APIs or the entities that have `public` visibility in our code-base.
```

*Does your PR introduce a new external dependency? (y/n), if yes, please explain the reason. In addition, please
also mention any other alternatives you've considered and the reason they've been discarded?:*

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- `CHANGELOG.md` with back-filling of the previous releases to the change log to provide more visibility on unreleased
changes and make the release process easier by using the `unreleased` section of change log. The `CONTRIBUTING.md`
has also been updated to ensure this is part of the process.
- backward-incompatiblity and dependency questions are added to the project's PR process to provide more context
on the changes that include these and the alternatives that have been considered.

### Changed

Expand Down