|
1 | | -Please check the type of change your PR introduces. |
| 1 | +<!-- |
| 2 | +Please fill in the relevant information below. |
2 | 3 |
|
3 | | -* [ ] Bugfix |
4 | | -* [ ] Documentation |
5 | | -* [ ] New Feature |
6 | | -* [ ] RFC |
7 | | -* [ ] QA |
8 | | -* [ ] Other |
| 4 | +**Target Branch** |
| 5 | +Given a current release of 1.0.0 |
9 | 6 |
|
10 | | -* [ ] BC Break? |
| 7 | +The next patch release = 1.0.1 |
| 8 | +The next minor = 1.1.0 |
| 9 | +The next major = 2.0.0 |
11 | 10 |
|
12 | | -Description: |
| 11 | +The branching strategy is as follows: (these are the branch names that you will target your PRs to) |
| 12 | +The Current release branch will be `1.0.x` |
| 13 | +The next minor branch will be `1.1.x` |
| 14 | +The next major branch will be `2.0.x` |
| 15 | +
|
| 16 | +Please target your pull request to the correct branch: |
| 17 | + * Documentation improvement: Current release branch |
| 18 | + * Bugfix: Current release branch |
| 19 | + * QA improvement (unit/integration tests, CS fixes, etc.) that does not change code |
| 20 | + behavior: Next minor 1.1.x |
| 21 | + * New feature/Refactor: Next minor 1.1.x |
| 22 | + * Any Backwards incompatible changes: Next major 2.0.x |
| 23 | +
|
| 24 | +You MUST provide a signoff in your commits for us to accept your |
| 25 | +contribution/patch. You can do this by providing either the --signoff or -s flag when using |
| 26 | +"git commit". |
| 27 | +--> |
| 28 | + |
| 29 | +| Q | A |
| 30 | +|-------------- | ------ |
| 31 | +| Documentation | yes/no |
| 32 | +| Bugfix | yes/no |
| 33 | +| BC Break | yes/no |
| 34 | +| New Feature | yes/no |
| 35 | +| RFC | yes/no |
| 36 | +| QA | yes/no |
| 37 | +| House Keeping | yes/no |
| 38 | + |
| 39 | +### Description |
| 40 | + |
| 41 | +<!-- |
| 42 | +
|
| 43 | +Why is this changed needed?: |
| 44 | +- Are you fixing a bug or providing a failing unit test to demonstrate a bug? |
| 45 | + - How do you reproduce it? |
| 46 | + - Expected behavior |
| 47 | + - Current behavior |
| 48 | + - TARGET THE CURRENT RELEASE BRANCH |
| 49 | +
|
| 50 | +- Are you adding documentation? |
| 51 | + - TARGET THE CURRENT RELEASE BRANCH |
| 52 | +
|
| 53 | +- Are you providing a QA improvement (unit/integration tests, CS fixes, etc.) that |
| 54 | + does not change behavior? |
| 55 | + - Explain why the changes are necessary |
| 56 | + - TARGET THE NEXT MINOR BRANCH |
| 57 | +
|
| 58 | +- Are you fixing a BC Break? (Please open an issue first) |
| 59 | + - How do you reproduce it? |
| 60 | + - What was the previous behavior? |
| 61 | + - What is the current behavior? |
| 62 | + - TARGET THE CURRENT RELEASE BRANCH |
| 63 | +
|
| 64 | +- Are you adding a new feature? (Please open an RFC first) |
| 65 | + - Why should it be added? |
| 66 | + - What are the potential use cases? |
| 67 | + - It must be documented. |
| 68 | + - TARGET THE NEXT MINOR BRANCH OR THE NEXT MAJOR IF BC WILL BE BROKEN |
| 69 | +
|
| 70 | +- Are you refactoring code? |
| 71 | + - Is it necessary? |
| 72 | + - What types of refactoring are you doing? |
| 73 | + - TARGET THE NEXT MINOR BRANCH OR THE NEXT MAJOR IF BC WILL BE BROKEN |
| 74 | +--> |
0 commit comments