Development Guidelines

• Code Documentation
  • Doxygen Generic Guidelines
  • C Code
    • Functions
    • Type Definitions
    • Files
    • Macros
    • Variables
• Documentation Guidelines
  • reST Syntax
    • Headings
    • Text Formatting
    • Tables
    • Lists
    • Code Blocks
    • Referencing Links
    • Images
    • Tabbed Content
    • Boxes
    • TODO, FIXME and DEPRECATED Tags
  • Spelling and Format Checkers
  • Glossary of Terms
• Contributing
  • Roles
  • Contribution Workflow
    • Internal Topic Branches
    • Submitting Commits
    • Review Assignment
    • Review Guide
    • Final Approval and Merging
  • Commit, Branch, and PRs Guidelines
    • PRs: Commit History
    • Commits: Structure, Format, and Sign-off
    • Commits and Branch Types
  • Github Repository Setup and Management
    • Repository Files
    • Author and Contributors
    • Branch Protection
    • CI/GitHub Actions
    • Repository Templates
    • Git Submodules Setup
• MISRA Compliance
  • Guideline Enforcement Plan (GEP) and Checker Tool
  • Rule Categories and Guideline Requalification Plan (GRP)
  • Deviations
    • Deviation Reasons
    • Deviation Procedure
    • Deviation annotations
    • Managing Stale Deviations
    • Deviation Records and Permits
  • Dealing with Pre-existing Violations
  • False Positive Diagnostics
  • Undecidable Guidelines and False Negative Diagnostics
  • Repository MISRA Artifacts
  • MISRA managers
  • Running the MISRA Checker Locally
• Releases and Versioning
  • Release Cycle
  • Release Announcement
  • Release Manager
  • Submodule Management