Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.89 KB

Getting Started

OpenFeature is not keen on vendor-specific stuff in this library, but if there are changes that need to happen in the spec to enable vendor-specific stuff in user code or other extension points, check out the spec.

Formatting

This repo uses ktlint for formatting.

Please consider adding a pre-commit hook for formatting using

./gradlew addKtlintCheckGitPreCommitHook

Manual formatting is done by invoking

./gradlew ktlintFormat

Releases

This repo uses Release Please to release packages. Release Please sets up a running PR that tracks all changes in the library, and maintains the versions according to conventional commits, generated when PRs are merged, based on the PR title. The semantics of the PR title are enforced by the lint-pr.yml workflow. When Release Please's running PR is merged, a new release is created, and the associated artifacts are published.

Customization of changelog and release notes.

If you'd like to add custom content to a release, you can do this by editing the content in a Release Please PR's description. This content will be added to the notes for that release. If you'd like to add content to the changelog, simply push updates to the changelog in the Release Please PR.

Configuration

The release-please-config.json defines the release please configuration. See schema here to understand all the options. We use the "simple" release strategy and annotate the build.gradle.kts file(s) with an element to help release please find the correct line to update version. Release Please stores it's understanding of the current version in the version.txt file.