Skip to content

Commit c6c9769

Browse files
authored
chore: CONTRIBUTING.md (#104)
* chore: CONTRIBUTING.md Signed-off-by: Skye Gill <[email protected]>
1 parent 9d262ca commit c6c9769

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Welcome!
2+
3+
There are a few things to consider before contributing to the sdk.
4+
5+
Firstly, there's [a code of conduct](https://github.com/open-feature/.github/blob/main/CODE_OF_CONDUCT.md).
6+
TLDR: be respectful.
7+
8+
Vendor specific details are intentionally not included in this module in order to be lightweight and agnostic.
9+
If there are changes needed to enable vendor specific behaviour in code or other extension points, check out [the spec](https://github.com/open-feature/spec).
10+
11+
Any contributions are expected to include unit tests. These can be validated with `make test` or the automated github workflow will run them on PR creation.
12+
13+
The go version in the `go.mod` is the currently supported version of go.
14+
15+
When writing a test to cover a spec requirement use the test naming convention `TestRequirement_x_y_z` where `x_y_z` is the numbering of the spec requirement (e.g. spec requirement `1.1.1` demands a test with name `TestRequirement_1_1_1`). Also include the description of the test requirement as a comment of the test.
16+
17+
Thanks! Issues and pull requests following these guidelines are welcome.

0 commit comments

Comments
 (0)