QtCS2017 Qt Examples Guidelines

From Qt Wiki
Revision as of 12:35, 10 October 2017 by Fredrik de Vibe (talk | contribs) (Created page with "Purpose of this discussion * Define what a good example is ** Coding guidelines *** Use of the auto keyword ** Translations? ** https://wiki.qt.io/Writing_Qt_Examples needs...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Purpose of this discussion

  • Define what a good example is
    • Coding guidelines
      • Use of the auto keyword
    • Translations?
    • https://wiki.qt.io/Writing_Qt_Examples needs cleanup
      • signals and slots: prefer template style
      • List from the examples revamping project
      • Refer to the coding style document instead of duplicating where appropriate
      • Fix <code> tags
    • C++ standard: ??
    • Qt Quick examples? Designer?
    • using namespace std?
    • Should work on all targets unless stated
      • What to do with those that don't
    • Should be self-contained
  • Who is responsible for writing and maintaining examples?
    • Module maintainers?
  • Who is responsible for maintaining the examples guidelines?
  • Examples and dependencies
    • Move examples that requires this to the documentation repository
  • Outdated examples
    • Keep a link, description and screenshot (if applicable) on the wiki and remove it from the repository