Skip to content

Commit 8743e79

Browse files
committed
workflow: move PR categories after PR guidelines
1 parent e8974cc commit 8743e79

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,6 @@ Before submitting a bug report or a bug fix, please [discuss it on the forums](h
1818

1919
All Mbed OS is on GitHub; please use GitHub's [issues mechanism](https://guides.github.com/features/issues/) to open a bug report directly against the relevant GitHub repository.
2020

21-
#### Pull request categories
22-
23-
##### Bugfixes
24-
25-
The last line in your commit message description should say “Fixes #deadbeef”, where “deadbeef” is the issue number in GitHub. This allows GitHub to automatically close the issue when the commit is merged into the default branch.
26-
27-
Every bugfix should contain a test to verify results prior and after the pull request.
28-
29-
##### Changes/additions
30-
31-
Backward compatible changes (refactoring, enhancements) or new target additions are considered to be part of the patch release.
32-
33-
##### Features
34-
35-
New features should initially be implemented on a separate branch in the Mbed OS repository. The naming convention for a feature branch is: "feature-".
36-
37-
Each feature has a tech lead. This person is responsible for:
38-
39-
- rebasing often to track master development
40-
- reviewing any addition to the feature branch (approval required by the feature owner or a person assigned to do instead)
41-
4221
#### Guidelines for GitHub pull requests
4322

4423
Pull requests on GitHub have to meet the following requirements to keep the code and commit history clean:
@@ -60,6 +39,27 @@ Pull requests on GitHub have to meet the following requirements to keep the code
6039
- Avoid merging commmits (use rebase if you could).
6140
- Pull requests shall fix a bug, add a feature or refactor but not a mixture.
6241

42+
#### Pull request categories
43+
44+
##### Bugfixes
45+
46+
The last line in your commit message description should say “Fixes #deadbeef”, where “deadbeef” is the issue number in GitHub. This allows GitHub to automatically close the issue when the commit is merged into the default branch.
47+
48+
Every bugfix should contain a test to verify results prior and after the pull request.
49+
50+
##### Changes/additions
51+
52+
Backward compatible changes (refactoring, enhancements) or new target additions are considered to be part of the patch release.
53+
54+
##### Features
55+
56+
New features should initially be implemented on a separate branch in the Mbed OS repository. The naming convention for a feature branch is: "feature-".
57+
58+
Each feature has a tech lead. This person is responsible for:
59+
60+
- rebasing often to track master development
61+
- reviewing any addition to the feature branch (approval required by the feature owner or a person assigned to do instead)
62+
6363
#### Mbed OS maintainers
6464

6565
The maintainers are a small group of Mbed OS engineers who are responsible for the Mbed OS codebase. Their primary role is to progress contributions, both internal and external, from the initial pull request state through to released code.

0 commit comments

Comments
 (0)