From fc6c15c83de4f9d34e570c1f1465e7a1f6abc798 Mon Sep 17 00:00:00 2001 From: "James E. King III" Date: Thu, 7 Feb 2019 17:16:59 -0500 Subject: Update the pull request template [ci skip] --- .github/pull_request_template.md | 46 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 .github/pull_request_template.md (limited to '.github') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..a6b4382b4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,46 @@ + + + + + + +- [ ] Did you squash your changes to a single commit? + +- [ ] Do you need an [Apache Jira](https://issues.apache.org/jira/projects/THRIFT/issues/) ticket?
Expand for guidance... + - `Yes` if your change requires a release note. + - `Yes` if your change is a breaking change. + - `No` if you change is trivial, such as fixing a typo. +
+ +- [ ] Is this change worthy of a release note?
Examples of Release Note-worthy examples... + - Breaking Changes + - New, Deprecated, or Removed Languages + - Security Fixes + - Significant Refactoring + - Changing how the product is built +
+ +- [ ] Breaking changes have additional requirements:
Expand for instructions... + - Add or reference an existing Apache Jira THRIFT ticket. + - Add a `Breaking-Change` label to the Jira ticket. + - Add a note to the `lib//README.md` file. + - Add a line to the `CHANGES.md` file. +
+ +- [ ] Does this change require a build?
Expand for guidance... + - `Yes` for any code change + - `Yes` for any build script change + - `Yes` for any docker build environment change + - `Yes` for any change affecting the cross test suite + - `No` for documentation-only changes + - `No` for trivial changes, for example fixing a typo. +
+ If your change does not require a build, you can add [ci skip] to the end of your commit message.
+ This will avoid costly and unnecessary builds in both the pull request and once it is merged. +
+ + -- cgit v1.2.1