Contributor’s Guide

• Introduction
  • Background
    • Authoritative Branch
    • Repository Code Management Team
• Contributing to the SRW App
  • Fork and PR Overview
  • Development and Testing Process
  • Opening an Issue
  • Making a Pull Request
    • PR Template
    • PR Template Guidance
    • Tips, Best Practices, and Protocols to Follow When Issuing a PR
  • Merging
  • Need Help?
• Code and Configuration Standards
  • General Policies
  • SRW Application Guidelines
    • Workflow Coding Standards
• Testing
  • Testing on Jenkins
• Working with Git Submodules
  • What Are Git Submodules?
  • Key Benefits
  • How Submodules Are Linked
  • Adding a Submodule
  • Cloning a Repository with Submodules
  • Updating a Submodule
    • Cloning the Authoritative Repository and Adding Your Personal Fork
    • Adding Your Personal Fork as a Remote Repository
    • Create Working Branches
    • Commit Changes and Push Working Branches
    • Submitting PRs
  • Switching Branches With Submodules
• Documentation
  • Locally Building and Previewing Documentation
  • Viewing Online Documentation
  • Documentation Guidelines
    • Troubleshooting Documentation
    • Technical Documentation Guidelines