docs: add about PR commits #6437
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is not so important thing.
We changed `git checkout` to `git switch` before.
MGatner
approved these changes
Aug 28, 2022
| 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. | ||
| 10. If you have touched PHP code, run static analysis. | ||
| - 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. See [Contribution Workflow](./workflow.md#commit-messages) for details. | ||
| 9. If you have touched PHP code, run static analysis. |
There was a problem hiding this comment.
We should update composer analyze to dry-run Rector as well, since that is part of our pipeline. I also just realized we aren't using Psalm here! Since you introduced me to it I've added it to all my libraries, and it frequently catches different things from PHPStan (especially around typing). I can look into that.
|
Now that you've created a good guide to writing commits, I thought it would be helpful to add how to edit wrong commits. |
This was referenced Aug 29, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Big commits and/or inappropriate commit messages make the reviews difficult.
Checklist: