Table of Contents

How to Contribute

Reporting Issues

When reporting issues, please include:

  • A clear description of the problem or feature request
  • Steps to reproduce the issue (for bugs)
  • Expected vs. actual behavior
  • Your environment details (.NET version, IDE, OS)
  • A minimal code example that demonstrates the issue

Contributing Code

  1. Fork the Repository: Create a fork of the repository on GitHub
  2. Create a Branch: Create a feature branch for your changes (git checkout -b feature/your-feature-name)
  3. Make Changes: Implement your changes with appropriate tests
  4. Test Thoroughly: Ensure all existing tests pass and add new tests for your changes
  5. Follow Code Style: Maintain consistency with the existing codebase
  6. Commit Changes: Use clear, descriptive commit messages
  7. Submit Pull Request: Create a pull request with a detailed description of your changes

Development Setup

  1. Clone the repository: git clone https://github.com/sator-imaging/TDoubles.git
  2. Open the solution in Visual Studio, VS Code, or JetBrains Rider
  3. Build the solution: dotnet build
  4. Run tests: dotnet test run-all-tests.bat

Code Guidelines

  • Follow C# coding conventions and best practices
  • Add XML documentation comments for public APIs
  • Include unit tests for new functionality
  • Ensure your code works with .NET Standard 2.0
  • Test with multiple .NET versions when possible

Areas for Contribution

We especially welcome contributions in these areas:

  • Bug fixes and performance improvements
  • Additional test coverage
  • Documentation improvements
  • Support for new C# language features
  • IDE integration enhancements
  • Example projects and tutorials