2. Contributor’s Guide

• 2.1. Introduction
  • 2.1.1. Background
    • 2.1.1.1. Authoritative Branch
    • 2.1.1.2. Repository Code Management Team
• 2.2. Contributing to the SRW App
  • 2.2.1. Fork and PR Overview
  • 2.2.2. Development and Testing Process
  • 2.2.3. Opening an Issue
  • 2.2.4. Making a Pull Request
    • 2.2.4.1. PR Template
    • 2.2.4.2. PR Template Guidance
    • 2.2.4.3. Tips, Best Practices, and Protocols to Follow When Issuing a PR
  • 2.2.5. Merging
  • 2.2.6. Need Help?
• 2.3. Code and Configuration Standards
  • 2.3.1. General Policies
  • 2.3.2. SRW Application Guidelines
    • 2.3.2.1. Workflow Coding Standards
• 2.4. Testing
  • 2.4.1. Testing on Jenkins
• 2.5. Working with Git Submodules
  • 2.5.1. What Are Git Submodules?
  • 2.5.2. Key Benefits
  • 2.5.3. How Submodules Are Linked
  • 2.5.4. Adding a Submodule
  • 2.5.5. Cloning a Repository with Submodules
  • 2.5.6. Updating a Submodule
    • 2.5.6.1. Cloning the Authoritative Repository and Adding Your Personal Fork
    • 2.5.6.2. Adding Your Personal Fork as a Remote Repository
    • 2.5.6.3. Create Working Branches
    • 2.5.6.4. Commit Changes and Push Working Branches
    • 2.5.6.5. Submitting PRs
  • 2.5.7. Switching Branches With Submodules
• 2.6. Documentation
  • 2.6.1. Locally Building and Previewing Documentation
  • 2.6.2. Viewing Online Documentation
  • 2.6.3. Documentation Guidelines