Thank you for your interest in contributing to the GrowthBook OpenFeature Provider for .NET!
-
Prerequisites:
- .NET 8 SDK
- An IDE (Visual Studio, VS Code with C# extension, or JetBrains Rider)
-
Clone the repository:
git clone https://github.com/growthbook/growthbook-openfeature-provider-dot-net.git cd growthbook-openfeature-provider-dot-net -
Restore dependencies:
dotnet restore
-
Build the solution:
dotnet build
-
Run tests:
dotnet test
-
Create a branch:
git checkout -b feature/your-feature-name
-
Implement your changes:
- Follow the existing code style and patterns
- Add/update tests as needed
- Ensure all tests pass
-
Run the sample app (optional):
cd GrowthBook.OpenFeature.SampleApp dotnet run
- Follow standard C# naming conventions and code style
- Use meaningful variable and method names
- Add XML documentation comments to public APIs
- Write unit tests for new functionality
- Keep methods small and focused on a single responsibility
-
Commit your changes:
git commit -m "Description of your changes" -
Push your branch:
git push origin feature/your-feature-name
-
Create a pull request:
- Go to the repository on GitHub
- Click "New pull request"
- Select your branch
- Fill out the PR template
-
Code review:
- Maintainers will review your code
- Address any feedback or requested changes
- Once approved, your PR will be merged
The maintainers follow this process for releases:
- Update version in project file
- Update CHANGELOG.md
- Create a GitHub release
- Publish to NuGet
If you have questions about contributing, please open an issue on GitHub.