Skip to content

Commit

Permalink
docs: Add notes about code contributions
Browse files Browse the repository at this point in the history
Hopefully this helps make PRs go a bit more smoothly.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
  • Loading branch information
tsandall committed Feb 22, 2019
1 parent 0d15d53 commit f42c0c7
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,22 @@ If you are contributing code, please consider the following:
- Most changes should be accompanied with tests.
- All commits must be signed off (see next section).
- Related commits must be squashed before they are merged.
- All tests must pass and there must be no warnings from the `make check` target.
- All tests must pass and there must be no warnings from the `make
check` target.

If you are new to Go, consider reading [Effective
Go](https://golang.org/doc/effective_go.html) and [Go Code Review
Comments](https://github.com/golang/go/wiki/CodeReviewComments) for
guidance on writing idiomatic Go code.

When you implement new features in OPA, consider whether the
types/functions you are adding need to be exported. Prefer
unexported types and functions as much as possible.

If you need to share logic across multiple OPA packages, consider
implementing it inside of the
`github.com/open-policy-agent/opa/internal` package. The `internal`
package is not visible outside of OPA.

## Commit Messages

Expand Down

0 comments on commit f42c0c7

Please sign in to comment.