Home

This developer wiki is under construction.
For developer issues, questions, and concerns, please post to our repo's discussion area here on GH.

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

• Developer Readme
• Doxygen docs
• 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

• General translation guidelines
• Using QtLinguist (preferred method)
• Using Text Editors
• Using Other Methods

6. In-App Documentation

• Modifying the in-App Documentation

7. Code details

• Classes

8. Misc

• GUI Screenshots