Skip to content

Contributing to Evoker Engine

We welcome contributions! This guide will help you get started.

Ways to Contribute

  • 🐛 Report bugs
  • 💡 Suggest features
  • 📝 Improve documentation
  • 🔧 Submit pull requests
  • ❓ Answer questions

Getting Started

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Make your changes
  4. Run tests: dotnet test
  5. Commit your changes: git commit -am 'Add my feature'
  6. Push to the branch: git push origin feature/my-feature
  7. Submit a pull request

Development Setup

See Installation Guide for prerequisites.

git clone https://github.com/yourusername/Evoker-Engine.git
cd Evoker-Engine
dotnet build
dotnet test

Code Style

  • Follow C# naming conventions
  • Use meaningful variable names
  • Add XML documentation comments for public APIs
  • Keep methods focused and small

Pull Request Process

  1. Update documentation if needed
  2. Add tests for new features
  3. Ensure all tests pass
  4. Update the README.md if needed
  5. Request review from maintainers

Reporting Bugs

Use the issue tracker to report bugs.

Include: - Clear description - Steps to reproduce - Expected vs actual behavior - System information - Code samples if applicable

Feature Requests

We love new ideas! Submit feature requests through the issue tracker.

License

By contributing, you agree that your contributions will be licensed under the project's license.