Skip to main content

Contributing to SGuard

Thank you for your interest in contributing to SGuard! We welcome contributions from everyone. This guide will help you get started.

How to Contribute​

  1. Fork the repository
    • Click the "Fork" button at the top of the GitHub page to create your own copy.
  2. Clone your fork
    • git clone https://github.com/<your-username>/sguard.git
  3. Create a branch
    • git checkout -b my-feature-branch
  4. Make your changes
    • Add your improvements, bug fixes, or documentation updates.
  5. Test your changes
    • Ensure all tests pass and your code is robust.
  6. Commit and push
    • git commit -am "Describe your change"
    • git push origin my-feature-branch
  7. Open a Pull Request
    • Go to your fork on GitHub and click "New Pull Request."

Code Style​

  • Follow .NET and C# best practices.
  • Write clear, concise, and well-documented code.
  • Add XML comments for public APIs.

Reporting Issues​

  • Use GitHub Issues to report bugs, request features, or ask questions.
  • Please provide as much detail as possible.

Community Standards​

License​

By contributing, you agree that your contributions will be licensed under the MIT License.


Thank you for helping make SGuard better!