From 85e3dd3e4536b36b416cd13079f5278f9d10a49b Mon Sep 17 00:00:00 2001 From: Olaoluwa Osuntokun Date: Mon, 9 Aug 2021 10:45:05 -0700 Subject: [PATCH] docs: add release notes to PR checklist and contributor guidelines --- .github/pull_request_template.md | 1 + docs/code_contribution_guidelines.md | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 18240055e..210e0ef30 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,3 +9,4 @@ - [ ] For bug fixes: If possible, code is accompanied by new tests which trigger the bug being fixed to prevent regressions - [ ] Any new logging statements use an appropriate subsystem and logging level - [ ] For code and documentation: lines are wrapped at 80 characters (the tab character should be counted as 8 characters, not 4, as some IDEs do per default) +- [ ] A description of your changes [should be added to running the release notes](https://github.com/lightningnetwork/lnd/tree/master/docs/release-notes) for the milestone your change will land in. diff --git a/docs/code_contribution_guidelines.md b/docs/code_contribution_guidelines.md index a9542dbb3..e0bad07b3 100644 --- a/docs/code_contribution_guidelines.md +++ b/docs/code_contribution_guidelines.md @@ -551,6 +551,12 @@ This process will continue until the code is finally accepted. ## Acceptance +Before your code is accepted, the [release notes we keep in-tree for the next +upcoming milestone should be extended to describe the changes contained in your +PR](https://github.com/lightningnetwork/lnd/tree/master/docs/release-notes). +Unless otherwise mentioned by the reviewers of your PR, the description of your +changes should live in the document set for the _next_ major release. + Once your code is accepted, it will be integrated with the master branch. After 2+ (sometimes 1) LGTM's (approvals) are given on a PR, it's eligible to land in master. At this final phase, it may be necessary to rebase the PR in order to