Contributing

Feel like making OpenKAT better? You can (hopefully) find all the content you need here. Do you miss something? Nice! You just found a way to contribute ;).

Contents

• Contributing
  • Introduction
• UI/UX design documentation
  • Figma
    • Design process
    • Fundamentals
    • Components
    • Design workfile
    • For review
    • Approved for implementation
• Project Guidelines
  • Project management
    • Feature Milestones
    • Bugs and Feature Requests
    • Pull Requests
    • In-depth content discussions
  • Development
    • Code
    • Tools
      • Pre-commit
    • Signed commits
    • Type Hinting
    • Testing
      • Unit Tests
      • Integration Tests
    • Development Environment
    • Merge Strategy
      • Branching
      • Reviews
      • Code commenting and documentation
    • Line ends
    • Technical diagrams
    • Dependency management
  • OpenKAT background and concepts
    • Indemnification statements
    • Safe viewing of boefjes-data (dutch)
    • OpenKAT as educational tool (dutch)
  • Contributions
    • Contribute to Codebase
    • Contribute Documentation
    • Contribute Translations
      • Adding a new language
    • Contributor Social Contract
    • Code of Conduct
    • Security
  • Feature flow
    • Getting features in the main branch
      • 1. Approved Features / Need Refinement → Refined Tasks
      • 2. In Progress → Review
      • 3. Review → QA review
      • 4. QA Review → Ready for Merge
      • 5. Ready for merge → Done
    • Releasing features
      • Environments for the extended QA
      • Checklist for QA
      • Extended checklist for QA
    • Tips and tricks for pull request QA testing
      • Think outside the box
      • Be pragmatic but versatile
  • Security
    • Security in the pipeline
      • SCA
      • SAST
      • Secret scanning
      • DAST
• GitHub Templates
  • Bug Report Template
  • Feature Request Template
  • Pull Request template for authors
  • Code review checklist for PR’s
  • QA checklist for PR’s