Skip to content

Commit

Permalink
DevKit updates (#522)
Browse files Browse the repository at this point in the history
  • Loading branch information
SonataCI committed Sep 18, 2021
1 parent 5571a9c commit a51c03c
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Show us you choose the right branch.
Different branches are used for different things :
- 2.x is for everything backwards compatible, like patches, features and deprecation notices
- master is for deprecation removals and other changes that cannot be done without a BC-break
- 3.x is for deprecation removals and other changes that cannot be done without a BC-break
More details here: https://github.com/sonata-project/exporter/blob/2.x/CONTRIBUTING.md#base-branch
-->
I am targeting this branch, because {reason}.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
push:
branches:
- 2.x
- master
- 3.x
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
push:
branches:
- 2.x
- master
- 3.x
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/qa.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
push:
branches:
- 2.x
- master
- 3.x
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
push:
branches:
- 2.x
- master
- 3.x
pull_request:

jobs:
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,19 +216,19 @@ Here is a short table resuming on which you have to start:
Kind of modification | Backward Compatible (BC) | Type of release | Branch to target | Label |
-------------------- | ------------------------ | --------------- | ----------------------- | ----- |
Bug fixes | Yes | Patch | `2.x` | |
Bug fixes | No (Only if no choice) | Major | `master` | |
Bug fixes | No (Only if no choice) | Major | `3.x` | |
Feature | Yes | Minor | `2.x` | |
Feature | No (Only if no choice) | Major | `master` | |
Feature | No (Only if no choice) | Major | `3.x` | |
Deprecation | Yes (Have to) | Minor | `2.x` | |
Deprecation removal | No (Can't be) | Major | `master` | |
Deprecation removal | No (Can't be) | Major | `3.x` | |

Notes:
* Branch `2.x` is the branch of the **latest stable** minor release and
has to be used for Backward compatible PRs.
* If you PR is not **Backward Compatible** but can be, it **MUST** be:
* Changing a function/method signature? Prefer create a new one and deprecate the old one.
* Code deletion? Don't. Please deprecate it instead.
* If your BC PR is accepted, you can do a new one on the `master` branch which removes the deprecated code.
* If your BC PR is accepted, you can do a new one on the `3.x` branch which removes the deprecated code.
* SYMFONY DOC REF (same logic)?

If you have a non-BC PR to propose, please try to create a related BC PR first.
Expand Down

0 comments on commit a51c03c

Please sign in to comment.