From 2635f96eba6517b44184866258f881a553d427eb Mon Sep 17 00:00:00 2001 From: Anthony Mirabella Date: Fri, 26 Jun 2020 20:50:19 -0400 Subject: [PATCH] Ask for changelog updates with PRs (#879) * Ask for changelog updates with PRs * Add PR ID to changelog entry * move changelog entry to unreleased --- CHANGELOG.md | 4 ++++ CONTRIBUTING.md | 10 +++++++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e4cefe34b81..9cde178ab25 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ## [Unreleased] +### Changed + +- Update `CONTRIBUTING.md` to ask for updates to `CHANGELOG.md` with each pull request. (#879) + ## [0.7.0] - 2020-06-26 This release implements the v0.5.0 version of the OpenTelemetry specification. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e12e7b3df17..210f933151f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,19 +67,21 @@ Enter the newly created directory and add your fork as a new remote: $ git remote add git@github.com:/opentelemetry-go ``` -Check out a new branch, make modifications, run linters and tests, and -push the branch to your fork: +Check out a new branch, make modifications, run linters and tests, update +`CHANGELOG.md`, and push the branch to your fork: ```sh $ git checkout -b # edit files +# update changelog $ make precommit $ git add -p $ git commit $ git push ``` -Open a pull request against the main `opentelemetry-go` repo. +Open a pull request against the main `opentelemetry-go` repo. Be sure to add the pull +request ID to the entry you added to `CHANGELOG.md`. ### How to Receive Comments @@ -99,6 +101,8 @@ A PR is considered to be **ready to merge** when: people reasonable time to review. * Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day. +* `CHANGELOG.md` has been updated to reflect what has been + added, changed, removed, or fixed. * Urgent fix can take exception as long as it has been actively communicated.