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

Also available in: Atom PDF