| James E. King III | 4927179 | 2019-01-28 08:32:47 -0500 | [diff] [blame^] | 1 | ### Pull Request Guidance ### |
| James E. King III | 85db0fe | 2018-04-06 08:37:11 -0400 | [diff] [blame] | 2 | |
| James E. King III | 4927179 | 2019-01-28 08:32:47 -0500 | [diff] [blame^] | 3 | Review the following items to ensure a smooth pull request experience. |
| James E. King, III | 8a6d9f4 | 2018-04-09 08:11:38 -0400 | [diff] [blame] | 4 | |
| James E. King III | 4927179 | 2019-01-28 08:32:47 -0500 | [diff] [blame^] | 5 | - [ ] Did you make a breaking change? If so: |
| 6 | |
| 7 | - [ ] Add (or reference) an [Apache Jira](https://issues.apache.org/jira/projects/THRIFT/issues/) THRIFT ticket. |
| 8 | - [ ] Add a `Breaking-Change` label to the Jira ticket. |
| 9 | - [ ] Add a note to the `lib/<language>/README.md` file. |
| 10 | - [ ] Add a line to the `CHANGES.md` file. |
| 11 | |
| 12 | - [ ] Is this change significant enough to be in release notes? |
| 13 | |
| 14 | All release-note worthy changes require an [Apache Jira](https://issues.apache.org/jira/projects/THRIFT/issues/) THRIFT ticket. |
| 15 | For example: |
| 16 | - Breaking Changes |
| 17 | - New, Deprecated, or Removed Languages |
| 18 | - Security Fix |
| 19 | - Significant Refactoring |
| 20 | |
| 21 | - [ ] If there is an [Apache Jira](https://issues.apache.org/jira/projects/THRIFT/issues/) ticket: |
| 22 | |
| 23 | - [ ] Is the [Apache Jira](https://issues.apache.org/jira/projects/THRIFT/issues/) THRIFT ticket identifier in the PR title? |
| James E. King III | 85db0fe | 2018-04-06 08:37:11 -0400 | [diff] [blame] | 24 | |
| 25 | THRIFT-9999: an example pull request title |
| 26 | |
| James E. King III | 4927179 | 2019-01-28 08:32:47 -0500 | [diff] [blame^] | 27 | - [ ] Is the [Apache Jira](https://issues.apache.org/jira/projects/THRIFT/issues/) THRIFT ticket identifier and affected languages in the commit message? |
| James E. King III | 85db0fe | 2018-04-06 08:37:11 -0400 | [diff] [blame] | 28 | |
| 29 | THRIFT-9999: [summary of fix, one line if possible] |
| 30 | Client: [language(s) affected, comma separated, use lib/ directory names please] |
| 31 | |
| James E. King III | 4927179 | 2019-01-28 08:32:47 -0500 | [diff] [blame^] | 32 | - [ ] Did you squash your changes to a single commit? |
| 33 | |
| 34 | Committers can squash when they merge, but sometimes we forget, and it makes the history |
| 35 | pretty dirty. Please squash your pull requests to a single commit if you can. |
| 36 | |
| James E. King III | 10cfd6a | 2018-04-06 08:43:04 -0400 | [diff] [blame] | 37 | For more information about committing, see CONTRIBUTING.md |