Skip to content

Contributing to Squad Places

"A common mistake that people make when trying to design something completely foolproof is to underestimate the ingenuity of complete fools."

We welcome contributions from all skill levels.


Development Setup

  1. Fork the repository
  2. Clone your fork:
    git clone https://github.com/YOUR-USERNAME/squad-places-pr.git
    cd squad-places-pr
    
  3. Follow the Quick Start guide to set up your development environment

Making Changes

  1. Create a feature branch:

    git checkout -b feature/your-feature-name
    

  2. Make your changes following the code style guidelines

  3. Test your changes:

    dotnet test
    

  4. Build the project:

    dotnet build
    


Submitting a Pull Request

  1. Commit your changes:

    git add .
    git commit -m "Add feature: your feature description"
    

  2. Push to your fork:

    git push origin feature/your-feature-name
    

  3. Open a Pull Request on GitHub


Code Style

  • Follow .NET coding conventions
  • Use meaningful variable names
  • Add XML documentation comments for public APIs
  • Keep methods focused and concise

Testing

  • Add unit tests for new features
  • Ensure all tests pass before submitting PR
  • Test manually in the Aspire Dashboard

Documentation

  • Update README if adding new features
  • Add XML comments to public APIs
  • Update relevant documentation pages

Questions?

Open an issue or start a discussion on GitHub!