Things To Look Out For In Reviews

From Qt Wiki
Revision as of 11:33, 5 January 2024 by Marc Mutz (talk | contribs) (→‎Polymorphic Classes: Fix itemizaton)
Jump to navigation Jump to search


This page is a low-entry-bar staging area for potential project-wide guidelines. After each release, we should go over each of these and decide whether we keep them here, or, preferably, fold them into Review Policy, API Design Principles, Commit Policy, Qt Coding Style, Coding Conventions or a new or existing QUIP.

Newly-Added Things

When adding a new Thing, don't forget to provide rationale.

Enums

New Classes

  • Make sure new classes follow the draft value-class mechanics QUIP-22.
  • Documentation:
    • Is the documentation for the class complete and in good shape (grammar, style, correctness)?
    • Is the class documented as new with \since?
    • Does the class provide a good overview section?
    • Is it properly linked from related API and overview documentation? In particular, check whether similar or related classes have any \ingroup commands and whether it makes sense the class should also have it!
    • Should the class be mentioned in the What's New in Qt 6 overview documentation?

Polymorphic Classes

Deprecated and Removed Things

  • Does the documentation reflect the deprecation, and mention the version it is first deprecated for (see also qdoc's \deprecated command? Does it give the user a rationale, as well as a suggestion for alternatives?

Decided To Keep Here

(make a proper subsection grouping when moving stuff here)