From b000bc02df16a16a21d0fe3467227c3bc6d62a0c Mon Sep 17 00:00:00 2001 From: "James E. King III" Date: Thu, 14 Feb 2019 17:58:04 -0500 Subject: Update the pull request template [ci skip] --- .github/pull_request_template.md | 37 +++---------------------------------- 1 file changed, 3 insertions(+), 34 deletions(-) (limited to '.github') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a6b4382b4..edd7befe8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,43 +1,12 @@ - +- [ ] Did you create an [Apache Jira](https://issues.apache.org/jira/projects/THRIFT/issues/) ticket? (not required for trivial changes) +- [ ] Does your pull request title follow the pattern "THRIFT-NNNN: describe my issue"? (not required for trivial changes) - [ ] 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. -
+- [ ] Did you do your best to avoid breaking changes? If one was needed, did you label the Jira ticket with "Breaking-Change"