Project

General

Profile

Actions

Task #104101

closed

Maybe add a cheatsheet to simplify onboarding for first-time reviewers

Added by Rozbeh Chiryai Sharahi about 1 month ago. Updated 13 days ago.

Status:
Closed
Priority:
Should have
Assignee:
-
Category:
Documentation
Target version:
Start date:
2024-06-13
Due date:
% Done:

0%

Estimated time:
TYPO3 Version:
13
PHP Version:
Tags:
Complexity:
hard
Sprint Focus:

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

Actions #1

Updated by Rozbeh Chiryai Sharahi about 1 month ago

  • Description updated (diff)
Actions #2

Updated by Rozbeh Chiryai Sharahi about 1 month ago

  • Description updated (diff)
Actions #3

Updated by Georg Ringer 23 days ago

  • Status changed from New to Resolved

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!

Actions #4

Updated by Garvin Hicking 22 days ago

@Rozbeh Chiryai Sharahi 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.

Actions #6

Updated by Benni Mack 13 days ago

  • Status changed from Resolved to Closed
Actions

Also available in: Atom PDF