diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c66e919..fced2e01 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,3 +87,43 @@ During development, you may need to utilize some `make` utils to update generate ## Submission Guidelines Ketch follows a lightweight Pull Request process. When submitting a PR, answering a few [basic questions](https://github.com/theketchio/ketch/blob/main/.github/pull_request_template.md) around type of change and steps to test and you are well on your way to a PR approval. + +## Your First Ketch Pull Request +Please Fork the project and create a branch to make your changes to. Directly commit your changes to your branch and then when +ready to merge upstream, feel free to and create a PR. There are quality steps that need to be achieved. + +`git checkout -b add-ketch-feature-of-squash-bug` + +### Running Tests +As a good practice, locally running the integration tests is a good idea. Because during the CI Step e.g GitHub Actions, these will be +run again as a quality gate. + +#### Unit Tests +Unit test coverage is in place. Running "make test" will run all of the Unit Tests e.g "Go Test". +`make test` + +Test coverage is represented as files suffixed as "test". A good idea is to include Unit Tests +with your changes. + +[Example Unit Test](https://github.com/theketchio/ketch/blob/main/internal/controllers/app_controller_test.go) + +#### Ketch CLI +The CLI has integration tests if you are making CLI level changes. These tests will run the +CLI against a live Ketch Installation. + +`./cli_tests/app.sh` +[Ketch App CLI Tests](https://github.com/theketchio/ketch/blob/main/cli_tests/app.sh#L3-L8) + +`./cli_tests/job.sh` +[Ketch Jobs CLI Tests](https://github.com/theketchio/ketch/blob/main/cli_tests/job.sh#L3-L8) + +### Submitting PR +When you commit via GitHub, there will be GitHub Actions that is ran on your behalf. +[GitHub Actions Config](https://github.com/theketchio/ketch/blob/main/.github/workflows/deploy.yaml#L50-L89) + +The GitHub Actions will create a temporary K3d cluster on the GitHub Actions Agent to run the tests. + +Assuming everything passes in your branch, you are now ready to create a Pull Request and get ready for the merge. + +#### PR Acceptance +Currently, one Core Contributor will have to accept the Pull Request. Thanks for your PR! diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 00000000..b7d97445 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,14 @@ +Here is a list of Contributors to the Ketch Project. + +# Core Contributors + +* [John Shenk](https://github.com/stinkyfingers) +* [Aleksej Paschenko](https://github.com/aleksej-paschenko) +* [Ravi Lachhman](https://github.com/ravilach) +* [Vivek Pandey](https://github.com/vivek) +* [David French](https://github.com/DavisFrench) +* [Stevan Koncar](https://github.com/koncar) +* [Kumar Saurabh](https://github.com/itsksaurabh) +* [Kavin Aravind](https://github.com/kavinaravind) + +Thanks so much for your contributions!