Overview

Create comprehensive guidelines for creating pull requests in the Stratos project to ensure consistency and quality across all contributions.

Requirements

1. Pre-Pull Request Checklist

   • Run and pass all tests (melos run test)
   • Pass linter and formatter checks (dvm dart analyze and melos format)
   • Remove unnecessary debug code and commented-out code
   • Update documentation (if necessary)

2. Pull Request Title Format

   • Format: type(scope): description
   • Type: feat, fix, docs, style, refactor, test, chore
   • Scope: stratos_core, stratos_app, etc.
   • Description: Brief description of changes in present tense
   • Example: feat(stratos_core): implement user authentication

3. Pull Request Description Template

   ## Related Issues
   
   Closes #123, #456
   Related #789
   
   ## Overview
   
   - Summary of implemented features or fixes
   
   ## Changes
   
   - List of specific changes
   
   ## Review Points
   
   - Specific points for reviewers to check
   - Concerns or points for discussion
   
   ## Additional Notes
   
   - Supplementary information or reference links

4. Branch Naming Convention

   • Format: GH-[issue number] or GH-[issue number]/[brief description]
   • Example: GH-123/feature-name

5. Preparation Steps

   • Extract GitHub Issue number from branch name:

     git branch --show-current | grep -o 'GH-[0-9]\+' | grep -o '[0-9]\+'

   • Check differences between current branch and main branch:

     git diff main...HEAD --name-status
     git diff main...HEAD
     git log main..HEAD --oneline

Acceptance Criteria

• Guidelines are clear and easy to understand
• All required sections are included and well-documented
• Examples are provided for each section
• Guidelines align with existing TDD workflow and rules
• Pre-pull request checklist is comprehensive
• Pull request title format is standardized
• Pull request description template is clear and complete
• Branch naming convention is established
• Preparation steps are well-documented
• Guidelines are reviewed and approved by team members

Additional Notes

• Consider creating a pull request template based on these guidelines
• Include links to TDD Rules and TDD Task Workflow documentation
• Consider adding automation to enforce guidelines where possible (e.g., PR title format, branch naming)