Skip to content

Contributing

Taiizor edited this page Dec 18, 2024 · 1 revision

🤝 Contributing

Thank you for considering contributing to the UUID project!

Development Environment

Requirements

  • Visual Studio 2022 or newer
  • .NET SDK 9.0 or newer
  • Git

Cloning the Project

git clone https://github.com/Taiizor/UUID.git
cd UUID

Contributing Steps

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Code Standards

  • Follow Microsoft's C# coding conventions
  • Add XML documentation for all public APIs
  • Add unit tests for new features
  • Add benchmarks for performance-critical methods

Testing

dotnet test

Running Benchmarks

cd benchmark
dotnet run -c Release

Pull Request Checklist

  • All tests pass
  • Tests added for new features
  • Code follows style guidelines
  • Documentation is updated
  • Changelog is updated

License

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

Communication

For questions:

  • Open an issue
  • Use the Discussions section
  • Create a pull request

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

Clone this wiki locally