Skip to content

Commit 2e95625

Browse files
committed
docs: move description from signing to workflow
1 parent 55fd7f0 commit 2e95625

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

contributing/signing.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,4 @@ bash shell to use the **-S** option to force the secure signing.
5252
## Commit Messages
5353

5454
Regardless of how you sign a commit, commit messages are important too.
55-
They communicate the intent of a specific change, concisely. They make
56-
it easier to review code, and to find out why a change was made if the
57-
code history is examined later.
58-
59-
The audience for your commit messages will be the codebase maintainers,
60-
any code reviewers, and debuggers trying to figure out when a bug might
61-
have been introduced.
62-
63-
Make your commit messages meaningful.
55+
See [Contribution Workflow](./workflow.md#commit-messages) for details.

contributing/workflow.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,17 @@ such as "Fix error on style guide", "Fix phpstan error", "Fix mistake in code",
154154
and other related commits, you can squash your commits so that we can have a clean commit history.
155155
But it is not a must.
156156

157-
### Commit messages
157+
### Commit Messages
158+
159+
Commit messages are important. They communicate the intent of a specific change, concisely.
160+
They make it easier to review code, and to find out why a change was made
161+
if the code history is examined later.
162+
163+
The audience for your commit messages will be the codebase maintainers,
164+
any code reviewers, and debuggers trying to figure out when a bug might
165+
have been introduced.
166+
167+
Make your commit messages meaningful.
158168

159169
Commit messages are expected to be descriptive of **why** and what you changed specifically.
160170
Commit messages like "Fixes #1234" would be asked by the reviewer to be revised.

0 commit comments

Comments
 (0)