Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add template readme #36

Merged
merged 5 commits into from
Apr 12, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ We recommend repositories in the project adhere to some security and maintenance
| static analysis | [SonarCloud][sonarcloud], language-specific tools (SpotBugs, eslint) |
| unit, integration testing | github actions (with permissions applying principle of least privilege), language-specific tools (JUnit, Jest, etc), [Cucumber][cucumber] |
| semantic versioning, changelogs | [Semantic Versioning][semantic-versioning], [Conventional Commits][conventional-commits], [Release Please][release-please]\*\*\* |
| helpful readme file | See [example README](./templates/READMEs/README.md).md |
beeme1mr marked this conversation as resolved.
Show resolved Hide resolved
toddbaert marked this conversation as resolved.
Show resolved Hide resolved

\* Branch protection rules should protect the primary branch (usually `main`) by requiring code review from the appropriate parties (other than the author), usually expressed in a CODEOWNERS file.

Expand All @@ -53,6 +54,7 @@ Additionally, we have an org-wide base config for Renovate.
[syft]: https://github.com/anchore/syft
[spdx]: https://spdx.dev/resources/tools/
[dependabot]: https://github.com/dependabot

[conventional-commits]: [https://www.conventionalcommits.org/]
[semantic-versioning]: [https://semver.org/]
[release-please]: [https://github.com/googleapis/release-please]
112 changes: 112 additions & 0 deletions templates/READMEs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
<!-- TODO: This is an template SDK README.md. It might also be useful for other repository types. Update the TODOs with correct examples/documentation. Replace all instances of "your-repo" with the appropriate name -->
toddbaert marked this conversation as resolved.
Show resolved Hide resolved

<!-- markdownlint-disable MD033 -->
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/white/openfeature-horizontal-white.svg">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/black/openfeature-horizontal-black.svg">
<img align="center" alt="OpenFeature Logo">
</picture>
</p>

<!-- TODO: update title -->
<h2 align="center">OpenFeature your-repo</h2>

<!-- TODO: add relevant badges -->
[![Specification](https://img.shields.io/static/v1?label=Specification&message=v0.5.2&color=yellow)](https://github.com/open-feature/spec/tree/v0.5.2)


## 👋 Hey there! Thanks for checking out the OpenFeature your-repo

### What is OpenFeature?

[OpenFeature][openfeature-website] is an open standard that provides a vendor-agnostic, community-driven API for feature flagging that works with your favorite feature flag management tool.

### Why standardize feature flags?

Standardizing feature flags unifies tools and vendors behind a common interface which avoids vendor lock-in at the code level. Additionally, it offers a framework for building extensions and integrations and allows providers to focus on their unique value proposition.

## 🔧 Components

<!-- TODO: if this is a monorepo, link to the submodule README files here and include the requirements, installation, features, and usage there. Otherwise, exclude this section -->

## 🔍 Requirements:

<!-- TODO: required runtime, etc -->

## 📦 Installation:

<!-- TODO: installation instructions -->

## 🌟 Features:

- support for various backend [providers](https://docs.openfeature.dev/docs/reference/concepts/provider)
- easy integration and extension via [hooks](https://docs.openfeature.dev/docs/reference/concepts/hooks)
- bool, string, numeric and object flag types
- [context-aware](https://docs.openfeature.dev/docs/reference/concepts/evaluation-context) evaluation

## 🚀 Usage:

### Basics:

<!-- TODO: code examples featuring setting a provider, getting a client, and doing an evaluation -->

### Context-aware evaluation:

Sometimes the value of a flag must take into account some dynamic criteria about the application or user, such as the user location, IP, email address, or the location of the server.
In OpenFeature, we refer to this as [`targeting`](https://docs.openfeature.dev/specification/glossary#targeting).
If the flag system you're using supports targeting, you can provide the input data using the `EvaluationContext`.

<!-- TODO: code examples using context and different levels -->

### Providers:

To develop a provider, you need to create a new project and include the OpenFeature SDK as a dependency. This can be a new repository or included in an existing contrib repository available under the OpenFeature organization. Finally, you’ll then need to write the provider itself. In most languages, this can be accomplished by implementing the provider interface exported by the OpenFeature SDK.
toddbaert marked this conversation as resolved.
Show resolved Hide resolved

<!-- TODO: code example implementing a provider -->

<!-- TODO: update with the technology in question -->
See [here](https://docs.openfeature.dev/docs/reference/technologies/server/javascript) for a catalog of available providers.

### Hooks:

Hooks are a mechanism that allow for the addition of arbitrary behavior at well-defined points of the flag evaluation life-cycle. Use cases include validation of the resolved flag value, modifying or adding data to the evaluation context, logging, telemetry, and tracking.

<!-- TODO: code example of a hook -->

<!-- TODO: update with the technology in question -->
See [here](https://docs.openfeature.dev/docs/reference/technologies/server/javascript) for a catalog of available hooks.

### Logging:

<!-- TODO: talk about logging config -->

## ⭐️ Support the project

- Give this repo a ⭐️!
- Follow us social media:
- Twitter: [@openfeature](https://twitter.com/openfeature)
- LinkedIn: [OpenFeature](https://www.linkedin.com/company/openfeature/)
- Join us on [Slack](https://cloud-native.slack.com/archives/C0344AANLA1)
- For more check out our [community page](https://docs.openfeature.dev/community/)

## 🤝 Contributing

Interested in contributing? Great, we'd love your help! To get started, take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.

### Thanks to everyone that has already contributed

<!-- TODO: update with correct repo -->
<a href="https://github.com/open-feature/your-repo/graphs/contributors">
<img src="https://contrib.rocks/image?repo=open-feature/your-repo" />
toddbaert marked this conversation as resolved.
Show resolved Hide resolved
</a>

Made with [contrib.rocks](https://contrib.rocks).

## 📜 License

[Apache License 2.0](LICENSE)

<!-- TODO: add FOSSA widget -->

[openfeature-website]: https://openfeature.dev