Skip to content

Commit

Permalink
Update CONTRIBUTING.md according to the comments
Browse files Browse the repository at this point in the history
  • Loading branch information
LesiaChaban authored Feb 23, 2024
1 parent 333fda3 commit 30c0568
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,22 @@ can be accepted.
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
what your changes are meant to do and provide simple steps on how to validate.
your changes. Ensure that you reference the issue you created as well.
1.1 The commits message should prefix "External-ccm:"
1.2 All commits should be squashed to a single commit before merging
1. We will assign the pull request to 2-3 people for review before it is merged.
1. Best Practices:
1.1 Follow the development guidelines [here](docs/development.md)
1.2 `govet`, `golint`, `gofmt` should pass on the PR
1.3 Make targets "build" and "test" should be successful on the PR
1.4 E2E should be run on a self managed test cluster, you will have to create a test
cluster with the image generated from your changes.
Please follow E2E guide [here](test/e2e/cloud-provider-oci/README.md)
1.5 E2E tests should pass on 3 versions of kubernetes currently supported by the repo.

### Commit Message

* The commits message should prefix "External-ccm:".
* All commits should be squashed to a single commit before merging.

### Best Practices:

* Follow the development guidelines [here](docs/development.md)
* `govet`, `golint`, `gofmt` should pass on the PR
* Make targets "build" and "test" should be successful on the PR
* E2E should be run on a self managed test cluster, you will have to create a test
cluster with the image generated from your changes.
Please follow E2E guide [here](test/e2e/cloud-provider-oci/README.md)
* E2E tests should pass on 3 versions of kubernetes currently supported by the repo.

## Code of conduct

Expand Down

0 comments on commit 30c0568

Please sign in to comment.