Skip to content

Latest commit

 

History

History
192 lines (137 loc) · 6.53 KB

CONTRIBUTING.md

File metadata and controls

192 lines (137 loc) · 6.53 KB
Raw

Contributing to the OpenFeature project

Development

You can contribute to this project from a Windows, macOS or Linux machine.

On all platforms, the minimum requirements are:

  • Git client and command line tools.
  • .netstandard 2.0 or higher capable dotnet sdk (.Net Framework 4.6.2 or higher/.Net Core 3 or higher).

Linux or MacOS

  • Jetbrains Rider 2022.2+ or Visual Studio 2022+ for Mac or Visual Studio Code

Windows

  • Jetbrains Rider 2022.2+ or Visual Studio 2022+ or Visual Studio Code
  • .NET Framework 4.6.2+

Pull Request

All contributions to the OpenFeature project are welcome via GitHub pull requests.

To create a new PR, you will need to first fork the GitHub repository and clone upstream.

git clone https://github.com/open-feature/dotnet-sdk.git openfeature-dotnet-sdk

Navigate to the repository folder

cd openfeature-dotnet-sdk

Add your fork as an origin

git remote add fork https://github.com/YOUR_GITHUB_USERNAME/dotnet-sdk.git

To start working on a new feature or bugfix, create a new branch and start working on it.

git checkout -b feat/NAME_OF_FEATURE
# Make your changes
git commit
git push fork feat/NAME_OF_FEATURE

Open a pull request against the main dotnet-sdk repository.

Running tests locally

Unit tests

To run unit tests execute:

dotnet test test/OpenFeature.Tests/

E2E tests

To be able to run the e2e tests, first we need to initialize the submodule and copy the test files:

git submodule update --init --recursive && cp test-harness/features/evaluation.feature test/OpenFeature.E2ETests/Features/

Afterwards, you need to start flagd locally:

docker run -p 8013:8013 ghcr.io/open-feature/flagd-testbed:latest

Now you can run the tests using:

dotnet test test/OpenFeature.E2ETests/

How to Receive Comments

  • If the PR is not ready for review, please mark it as draft.
  • Make sure all required CI checks are clear.
  • Submit small, focused PRs addressing a single concern/issue.
  • Make sure the PR title reflects the contribution.
  • Write a summary that helps understand the change.
  • Include usage examples in the summary, where applicable.

How to Get PRs Merged

A PR is considered to be ready to merge when:

  • Major feedbacks are resolved.
  • It has been open for review for at least one working day. This gives people reasonable time to review.
  • Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day.
  • Urgent fix can take exception as long as it has been actively communicated.

Any Maintainer can merge the PR once it is ready to merge. Note, that some PRs may not be merged immediately if the repo is in the process of a release and the maintainers decided to defer the PR to the next release train.

If a PR has been stuck (e.g. there are lots of debates and people couldn't agree on each other), the owner should try to get people aligned by:

  • Consolidating the perspectives and putting a summary in the PR. It is recommended to add a link into the PR description, which points to a comment with a summary in the PR conversation.
  • Tagging subdomain experts (by looking at the change history) in the PR asking for suggestion.
  • Reaching out to more people on the CNCF OpenFeature Slack channel.
  • Stepping back to see if it makes sense to narrow down the scope of the PR or split it up.
  • If none of the above worked and the PR has been stuck for more than 2 weeks, the owner should bring it to the OpenFeatures meeting.

Automated Changelog

Each time a release is published the changelogs will be generated automatically using dotnet-releaser. The tool will organise the changes based on the PR labels.

  • 🚨 Breaking Changes = breaking-change
  • ✨ New Features = feature
  • 🐛 Bug Fixes = bug
  • 🚀 Enhancements = enhancement
  • 🧰 Maintenance = maintenance
  • 🏭 Tests = tests, test
  • 🛠 Examples = examples
  • 📚 Documentation = documentation
  • 🌎 Accessibility = translations
  • 📦 Dependencies = dependencies
  • 🧰 Misc = misc

Design Choices

As with other OpenFeature SDKs, dotnet-sdk follows the openfeature-specification.

Style Guide

This project includes a .editorconfig file which is supported by all the IDEs/editor mentioned above. It works with the IDE/editor only and does not affect the actual build of the project.

Benchmarking

We use BenchmarkDotNet NuGet package to benchmark a code.

To run pipelines locally, you can follow these commands from a root project directory.

dotnet restore
dotnet build --configuration Release --output "./release" --no-restore
dotnet release/OpenFeature.Benchmarks.dll

Consuming pre-release packages

  1. Acquire a GitHub personal access token (PAT) scoped for read:packages and verify the permissions:

    $ gh auth login --scopes read:packages

? What account do you want to log into? GitHub.com
? What is your preferred protocol for Git operations? HTTPS
? How would you like to authenticate GitHub CLI? Login with a web browser

! First copy your one-time code: ****-****
Press Enter to open github.com in your browser...

✓ Authentication complete.
- gh config set -h github.com git_protocol https
✓ Configured git protocol
✓ Logged in as ********
    $ gh auth status

github.com
  ✓ Logged in to github.com as ******** (~/.config/gh/hosts.yml)
  ✓ Git operations for github.com configured to use https protocol.
  ✓ Token: gho_************************************
  ✓ Token scopes: gist, read:org, read:packages, repo, workflow

  2. Run the following command to configure your local environment to consume packages from GitHub Packages:

    $ dotnet nuget update source github-open-feature --username $(gh api user --jq .email) --password $(gh auth token) --store-password-in-clear-text

Package source "github-open-feature" was successfully updated.