Home

This wiki is under construction. If you don't see what you need here or on the forum please ask your question on the forum for best results.

Table of Contents

1. Code

• GitHub Flow
• Code Style
• Code Blocks
• Codesee

2. Repo

• Issues
• Github Actions
• Releases

3. Build

• Qt5
• Code signing
• Qt6

4. Documentation

• Commenting C++ code -- The Rubin Observatory has an excellent guide here
  • Documenting Classes and Type Aliases
  • Documenting Enumerated Types
  • Documenting Methods and Functions
  • Documenting Constants, Variables, and Data Members
• Automated Pull Request comments -- What the Diff
• Automated Changelog entries -- Changelogg
• Automated Code documentation -- Doxygen

5. Translations

• Using QtLinguist (preferred method)
• Using Text Editors
• Using Other Methods

6. Misc

• Screenshots