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

Update Contributing Guidelines #419

Merged
merged 1 commit into from
Mar 3, 2022
Merged
Changes from all commits
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
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
# Contributing Guidelines

## As a Developer
## As a Contributor
### Fork and branch
Local development has to be done in the forked repo of [cluster-api-provider-bringyourownhost](https://github.com/vmware-tanzu/cluster-api-provider-bringyourownhost). Here are some examples of meaningful branch names
* add-host-reservation-logic
* update-readme
* fix-byomachine-controller-flakes
* refactor-agent-unit-tests

### Writing tests
We expect our contributors to write unit / integration tests when making any code change. For tests like e2e, feel free to create a child issue and work on it separately.

#### Testing Framework
- We use [Ginkgo](https://onsi.github.io/ginkgo/) and [Gomega](https://onsi.github.io/gomega/) extensively for testing (unit / integration and e2e)
- For mocking interfaces and methods, we use the [Counterfeiter](https://github.com/maxbrunsfeld/counterfeiter) tool. Use this to generate fake implementations for your unit tests.

### Commit Message
If you are pairing on a PR, make sure to use [git-duet](https://github.com/git-duet/git-duet)

@@ -19,6 +26,7 @@ At the minimum,

### Raising a PR
* all PRs should be raised against the main branch of [cluster-api-provider-bringyourownhost](https://github.com/vmware-tanzu/cluster-api-provider-bringyourownhost)
* all code changes should be accompanied with corresponding unit / integration tests (if for some reason, the code is not unit / integration testable, add enough justification in the PR. Although, this almost should never be the case.)

### Contributor License Agreement
All contributors to this project must have a signed Contributor License