Skip to content

Commit 8cd60e0

Browse files
committed
Add a contributing.md
Fixes open-feature#21
1 parent 803693f commit 8cd60e0

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Welcome! Super happy to have you here.
2+
3+
A few things.
4+
5+
First, we have [a code of
6+
conduct](https://github.com/open-feature/.github/blob/main/CODE_OF_CONDUCT.md). Don't
7+
be a jerk.
8+
9+
We're 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](https://github.com/open-feature/spec).
10+
11+
Any contributions you make are expected to be tested with unit tests. You can validate these work with `gradle test`, or the automation itself will run them for you when you make a PR.
12+
13+
Your code is supposed to work with Java 11+.
14+
15+
If you think we might be out of date with the spec, you can check that by invoking `python spec_finder.py` in the root of the repository. This will validate we have tests defined for all of the specification entries we know about.
16+
17+
If you're adding tests to cover something in the spec, use the `@Specification` annotation like you see throughout the test suites.
18+
19+
Thanks and looking forward to your issues and pull requests.

0 commit comments

Comments
 (0)