malhuda/CodeIgniter4
1
0
Fork 0
mirror of https://github.com/codeigniter4/CodeIgniter4.git synced 2025-02-20 11:44:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: move description from signing to workflow

Browse Source
This commit is contained in:
kenjis 2022-08-28 12:50:52 +09:00
parent 55fd7f0239
commit 2e95625817
No known key found for this signature in database
GPG Key ID: BD254878922AF198
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
contributing/signing.md
View File

@ -52,12 +52,4 @@ bash shell to use the **-S** option to force the secure signing.
## Commit Messages ## Commit Messages
Regardless of how you sign a commit, commit messages are important too. Regardless of how you sign a commit, commit messages are important too.
They communicate the intent of a specific change, concisely. They make See [Contribution Workflow](./workflow.md#commit-messages) for details.
it easier to review code, and to find out why a change was made if the
code history is examined later.
The audience for your commit messages will be the codebase maintainers,
any code reviewers, and debuggers trying to figure out when a bug might
have been introduced.
Make your commit messages meaningful.

12
contributing/workflow.md
View File

@ -154,7 +154,17 @@ such as "Fix error on style guide", "Fix phpstan error", "Fix mistake in code",
and other related commits, you can squash your commits so that we can have a clean commit history. and other related commits, you can squash your commits so that we can have a clean commit history.
But it is not a must. But it is not a must.
### Commit messages ### Commit Messages
Commit messages are important. They communicate the intent of a specific change, concisely.
They make it easier to review code, and to find out why a change was made
if the code history is examined later.
The audience for your commit messages will be the codebase maintainers,
any code reviewers, and debuggers trying to figure out when a bug might
have been introduced.
Make your commit messages meaningful.
Commit messages are expected to be descriptive of **why** and what you changed specifically. Commit messages are expected to be descriptive of **why** and what you changed specifically.
Commit messages like "Fixes #1234" would be asked by the reviewer to be revised. Commit messages like "Fixes #1234" would be asked by the reviewer to be revised.