#104101Maybe add a cheatsheet to simplify onboarding for first-time reviewers
Description
Some ideas:
- Clarify (shortly) who is allowed to review
- Note that many of the tasks are already covered by cgl and list is only for further common code-review steps
- Add a checklist of common code-review habits of experienced reviewers, see examples:
— check exception timestamps
— check declare strict
— check …
— check if documenation matches implementation
Further, annotate that this documentation is subject to
- frequent change
- not claiming completeness
- stays a cheatsheet without in dept information to be easily adapted over time
Reviews 0
No change resolves or names this issue in its commit message, and no comment links one.
History 6
-
Rozbeh Chiryai Sharahi changed description 06/13/24, 18:43
-
Rozbeh Chiryai Sharahi changed description 06/13/24, 19:12
-
Georg Ringer commented and changed status
NewResolved 06/25/24, 04:40 -
Garvin Hicking commented 06/25/24, 05:56
@rozbehsharahi I will create a PR in the docs and try to add some of your ideas there, would love to get your feedback and maybe help improving it towards contributors like you. Will post the link here when I get to it.
-
Garvin Hicking commented 06/26/24, 14:57
I’ve tried to address this via a few PRs and one commit:
https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-ContributionWorkflow/commit/c3ee0e2a276b380dd02b0cd4fba8abee15a92b7d
https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-ContributionWorkflow/pull/339
https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-ContributionWorkflow/pull/340
https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-ContributionWorkflow/pull/341Would be happy for comments / feedback or additions there!
-
Benni Mack changed status
ResolvedClosed 07/04/24, 13:16
Hey,
thanks for the issue. I am closing it as a lot of that is already listed at https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/BugfixingAZ/Index.html
feel free to make a PR at github for the docs but IMHO it is not useful to make a list of things like timestamps, declare strict as this list would just be endless. this is why there are reviews and people helping you on the way.
if you don’t agree, feel free to contact me via slack!