Skip to content

Commit 8618ea5

Browse files
committed
[EGD-5241] Update development workflow documentation
Remove the obligation to update the changelog with every PR. Remove obligation to start a change description with "Change" verb. Add some other minor spelling and grammar fixes. Update commit message template to reflect the changes.
1 parent fdfe1f5 commit 8618ea5

File tree

3 files changed

+13
-15
lines changed

3 files changed

+13
-15
lines changed

.gitmessage

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
# Commit subject: [JIRA-TICKET] <Add/Change/Fix> changes summary, don't end with a period
1+
# Commit subject: [JIRA-TICKET] Changes summary, don't end with a period
22
# No more than 72 chars. ########################### 72 chars is here: #
3-
<Title>
4-
# Remember blank line between title and commit message.
53

64
# Commit message: Explain *what* and *why* (not *how*).
75
# Wrap at 72 chars. ################################### which is here: #

doc/development_workflow.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,19 @@ Each commit that makes it from your branch or fork into the master branch must h
1515
If you're part of the MuditaOS core development team, your commit's title *must* start with a Jira ticket number in square brackets e.g. `[EGD-5555]`.
1616

1717
Commits from the community will be accompanied by a relevant Jira ticket number during the merge. Don't add commits that are out of the scope of the Jira issue you are working on.
18+
You should have exactly one commit in a single PR.
1819

1920
Your commit's subject line should be a single sentence describing what you are changing using present simple tense and an imperative mood. Please follow these rules:
2021

21-
- It must start with one of the following verbs: "Add", "Change" or "Fix", depending on whether you are adding a new feature, changing its behavior, or fixing it. This sentence will be a part of the project changelog, so please ensure it will be clear to the non-technical readers.
22+
- It must start with a verb. This sentence will be a part of the project changelog, so please ensure it will be clear to the non-technical readers.
23+
- If you are adding a new feature start with "Add"; start with "Fix" if you are fixing one.
2224
- Don't use proper names such as names of classes or functions.
2325
- Try to be as concise as possible in the limit of 72 characters (including the Jira ticket number - 11 characters).
2426
- Don't end the subject line with a period.
2527

2628
Then, in the commit message, you must include a short description of what the commit is changing in the project. You should be clear about
2729
your motivation to do the change and how it influences the project.
28-
29-
If it's impossible to provide any of the above information, then your commit is likely excessive or redundant and should be squashed with another commit.
30+
Focus more on *why* than *how*.
3031

3132
An example of a correctly formatted commit:
3233
```
@@ -50,13 +51,12 @@ You can add a commit template and hook that will help with proper defining both
5051

5152
Before submitting a Pull Request please go through some basic checks:
5253

53-
- test your changes on both Linux and RT1051 platforms (please pay special attention to the things you might break unintentionally, e.g. when working on calling funcionality, check call log too)
54-
- [include changelog description](changelog_howto.md) (if applicable),
54+
- test your changes on both Linux and RT1051 platforms (please pay special attention to the things you might break unintentionally, e.g. when working on calling, check call log too,
5555
- run unit tests (`make check`),
5656
- check if your code formatting complies with [`.clang-format`](../clang-format),
57-
- whenever you add a third party software to MuditaOS source code, please make sure that the software component is added to a dedicated [section in `LICENSE.md` file on MuditaOS GitHub repository](../LICENSE.md) with a link to the text of the license where applicable.
57+
- whenever you add third-party software to MuditaOS source code, please make sure that the software component is added to a dedicated [section in `LICENSE.md` file on MuditaOS GitHub repository](../LICENSE.md) with a link to the text of the license where applicable.
5858

59-
As a part of our continuous integration proccess we will be soon introducing our own [test harness](../test/README.md).
59+
As a part of our continuous integration process we will be soon introducing our own [test harness](../test/README.md).
6060

6161
## Submit a Pull Request
6262

@@ -78,7 +78,7 @@ During a PR review, team members will ask you questions regarding your solution.
7878

7979
## PR review - act on feedback
8080

81-
Add changes to your PR that are requested by reviewers and push the feature branch once again. Update comments requesting changes with a simple `Done`. Don't resolve discussion on your own, it's the reviewer's responsibility to do so.
81+
Add changes to your PR that are requested by reviewers and push the feature branch once again. Update comments requesting changes with a simple `Done`. Don't resolve a discussion on your own, it's the reviewer's responsibility to do so.
8282

8383
## Merge to `master` branch
8484

@@ -110,7 +110,7 @@ git rebase origin/master # update branch you are at to origin/master
110110

111111
`Rebase` changes your commit history (moves them on top). This means two things:
112112

113-
- when you did a lot of changes in a lot of places - either `git push` your branch on server, or make its copy
113+
- when you did a lot of changes in a lot of places - either `git push` your branch to the server, or make its copy
114114
- when you're happy of `git rebase` results - you'll need to push your branch with force to server - since you've changed its history (updated it)
115115

116116
A minimal set of commands:

doc/quickstart.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -148,14 +148,14 @@ To fix the style for Pull Request CI:
148148

149149
### Commit message template
150150

151-
To add commit message template use this command:
151+
To add a commit message template use this command:
152152

153153
```bash
154154
git config commit.template .gitmessage
155155
```
156156

157-
This way each time you add new commit you will see template that will help
158-
you with proper message format. More about that in (Development Workflow)[./doc/development_workflow.md#commit-changes]
157+
This way each time you add a new commit you will see the template that will help
158+
you with the proper message format. More about that in (Development Workflow)[./doc/development_workflow.md#commit-changes]
159159

160160
### Commit message hook
161161
This hooks automatically converts your branch name to commit title

0 commit comments

Comments
 (0)