Skip to content

Commit 2635f96

Browse files
authored
Ask for changelog updates with PRs (#879)
* Ask for changelog updates with PRs * Add PR ID to changelog entry * move changelog entry to unreleased
1 parent 01b6452 commit 2635f96

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
88

99
## [Unreleased]
1010

11+
### Changed
12+
13+
- Update `CONTRIBUTING.md` to ask for updates to `CHANGELOG.md` with each pull request. (#879)
14+
1115
## [0.7.0] - 2020-06-26
1216

1317
This release implements the v0.5.0 version of the OpenTelemetry specification.

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,19 +67,21 @@ Enter the newly created directory and add your fork as a new remote:
6767
$ git remote add <YOUR_FORK> git@github.com:<YOUR_GITHUB_USERNAME>/opentelemetry-go
6868
```
6969

70-
Check out a new branch, make modifications, run linters and tests, and
71-
push the branch to your fork:
70+
Check out a new branch, make modifications, run linters and tests, update
71+
`CHANGELOG.md`, and push the branch to your fork:
7272

7373
```sh
7474
$ git checkout -b <YOUR_BRANCH_NAME>
7575
# edit files
76+
# update changelog
7677
$ make precommit
7778
$ git add -p
7879
$ git commit
7980
$ git push <YOUR_FORK> <YOUR_BRANCH_NAME>
8081
```
8182

82-
Open a pull request against the main `opentelemetry-go` repo.
83+
Open a pull request against the main `opentelemetry-go` repo. Be sure to add the pull
84+
request ID to the entry you added to `CHANGELOG.md`.
8385

8486
### How to Receive Comments
8587

@@ -99,6 +101,8 @@ A PR is considered to be **ready to merge** when:
99101
people reasonable time to review.
100102
* Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for
101103
one day.
104+
* `CHANGELOG.md` has been updated to reflect what has been
105+
added, changed, removed, or fixed.
102106
* Urgent fix can take exception as long as it has been actively
103107
communicated.
104108

0 commit comments

Comments
 (0)