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.

Sign up for GitHub

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

docs: Update Acceptance policy #4053

Merged
merged 3 commits into from
Oct 2, 2023
Merged

docs: Update Acceptance policy #4053

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a055d3b
Update CONTRIBUTING.md
yiannistri Oct 2, 2023
3f72c4f
docs: Code review changes
yiannistri Oct 2, 2023
21fb6cc
Merge branch 'main' into docs-acceptance-policy
yiannistri Oct 2, 2023
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
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ These things will make a PR more likely to be accepted:
- tests for old code!
- new code and tests follow the conventions in old code and tests
- a good commit message (see below)
- all code must abide [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
- names should abide [What's in a name](https://talks.golang.org/2014/names.slide#1)
- code must build on both Linux and Darwin, via plain `go build`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a tricky one to enforce. It makes sense, but as a random person if I try to join to contribute that may make some uncertainties as I have no mac where I can test and build.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, this is not meant to be a strict/hard requirement but rather an acknowledgment that a simple go build should be sufficient.

- code should have appropriate test coverage and tests should be written
to work with `go test`

In general, we will merge a PR once at least one maintainer has endorsed it. For substantial changes, more people may become involved, and you might get asked to resubmit the PR or divide the changes into more than one PR.

Expand Down