Skip to content

Commit e215d66

Browse files
committed
docs: remove description on squashing commits
It is not so important thing.
1 parent 799d655 commit e215d66

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

contributing/pull_request.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -249,18 +249,17 @@ The best way to contribute is to fork the CodeIgniter4 repository, and "clone" t
249249
7. Fix existing bugs on the [Issue tracker](https://github.com/codeigniter4/CodeIgniter4/issues) after confirming that no one else is working on them.
250250
8. [Commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) the changed files in your contribution branch.
251251
- `> git commit`
252-
- Commit messages are expected to be descriptive of what you changed specifically. Commit messages like "Fixes #1234" would be asked by the reviewer to be revised.
253-
9. If there are intermediate commits that are not meaningful to the overall PR, such as "Fixed error on style guide", "Fixed phpstan error", "Fixing mistake in code", and other related commits, it is advised to squash your commits so that we can have a clean commit history.
254-
10. If you have touched PHP code, run static analysis.
252+
- 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. [Atomic commit](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention) is recommended.
253+
9. If you have touched PHP code, run static analysis.
255254
- `> composer analyze`
256255
- `> vendor/bin/rector process`
257-
11. Run unit tests on the specific file you modified. If there are no existing tests yet, please create one.
256+
10. Run unit tests on the specific file you modified. If there are no existing tests yet, please create one.
258257
- `> vendor/bin/phpunit tests/system/path/to/file/you/modified`
259258
- Make sure the tests pass to have a higher chance of merging.
260-
12. [Push](https://docs.github.com/en/github/using-git/pushing-commits-to-a-remote-repository) your contribution branch to your fork.
259+
11. [Push](https://docs.github.com/en/github/using-git/pushing-commits-to-a-remote-repository) your contribution branch to your fork.
261260
- `> git push origin <new-branch-name>`
262-
13. Send a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
263-
14. Label your pull request with the appropriate label if you can.
261+
12. Send a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
262+
13. Label your pull request with the appropriate label if you can.
264263

265264
See [Contribution workflow](./workflow.md) for Git workflow details.
266265

0 commit comments

Comments
 (0)