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¶
- Fork the repository
- Clone your fork:
- Follow the Quick Start guide to set up your development environment
Making Changes¶
-
Create a feature branch:
-
Make your changes following the code style guidelines
-
Test your changes:
-
Build the project:
Submitting a Pull Request¶
-
Commit your changes:
-
Push to your fork:
-
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!