From e4c65f8c86b16cf2acad8430889efbd15204984d Mon Sep 17 00:00:00 2001 From: thepetk Date: Mon, 11 Dec 2023 16:31:59 +0000 Subject: [PATCH 1/9] Update contributing guide Signed-off-by: thepetk --- CONTRIBUTING.md | 74 ++++++++++++++++++++++++++++++++++--------------- 1 file changed, 52 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1801f038..eb7ece68 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,33 +1,63 @@ -# How to contribute +# Contributing -Contributions are essential for keeping this library great. -We try to keep it as easy as possible to contribute changes and we are -open to suggestions for making it even easier. -There are only a few guidelines that we need contributors to follow. +Thank you for your interest in contributing to Alizer! We welcome your additions to this project. -## First Time Setup -1. Install prerequisites: - * [Java Development Kit](https://adoptopenjdk.net/) -2. Fork and clone the repository -3. `cd alizer` -4. Import the folder as a project inyour favorite IDE +## Code of Conduct +Before contributing to this repository for the first time, please review our project's [Code of Conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md) -## Commit Messages -Commit messages on main branches must follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary). Contributors are encouraged to use them as well, but maintainers will happily fix things up when merging pull requests if needed. +## Certificate of Origin -The Conventional Commits specification is a lightweight convention on top of commit messages, which allow us to automate the release process. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. +By contributing to this project you agree to the Developer Certificate of +Origin (DCO). This document was created by the Linux Kernel community and is a +simple statement that you, as a contributor, have the legal right to make the +contribution. See the [DCO](DCO) file for details. + +## How to contribute: + +### Issues + +If you spot a problem with devfile alizer, [search if an issue already exists](https://github.com/devfile/api/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/devfile/api/issues/new/choose). + +You can tag Alizer related issues with the `/area alizer` text in your issue. + +### Development + +#### Repository Format + +The `alizer` repository includes different components: + +- [CLI](./README.md#cli) +- [Alizer Library](./README.md#library-package) + +As a result `alizer` can be used both as a cli tool and imported as a package inside other projects. More information for the repository can be found [here](./docs/public/alizer-spec.md) + +#### Building locally -Your commit messages should be structured as follows: +More information for building & running locally the project can be found [here](./README.md#usage) + +#### Testing + +Apart from testing your changes locally with an updated Alizer CLI, someone can test their changes by running `make test`. This will test the updates against all existing test cases. + +### Submitting Pull Request + +**Note:** All commits must be signed off with the footer: ``` -[optional scope]: +Signed-off-by: First Lastname ``` -Read more about [commit types](https://github.com/pvdlg/conventional-commit-types#commit-types). -### Certificate of Origin +You can easily add this footer to your commits by adding `-s` when running `git commit`. When you think the code is ready for review, create a pull request and link the issue associated with it. -By contributing to this project you agree to the Developer Certificate of -Origin (DCO). This document was created by the Linux Kernel community and is a -simple statement that you, as a contributor, have the legal right to make the -contribution. See the [DCO](DCO) file for details. +Owners of the repository will watch out for and review new PRs. + +By default for each change in the PR, GitHub Actions and OpenShift CI will run checks against your changes (linting, unit testing, and integration tests). + +If comments have been given in a review, they have to be addressed before merging. + +After addressing review comments, don't forget to add a comment in the PR afterward, so everyone gets notified by Github and know to re-review. + +# Contact us + +If you have questions, please visit us on `#devfile` in the [Kubernetes Slack](https://slack.k8s.io). From 8e5af44f9b898379b64f953586c54201f215f807 Mon Sep 17 00:00:00 2001 From: Theofanis Petkos Date: Tue, 12 Dec 2023 11:16:14 +0000 Subject: [PATCH 2/9] Update CONTRIBUTING.md Co-authored-by: Michael Valdron Signed-off-by: thepetk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb7ece68..08c7e71c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ contribution. See the [DCO](DCO) file for details. ### Issues -If you spot a problem with devfile alizer, [search if an issue already exists](https://github.com/devfile/api/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/devfile/api/issues/new/choose). +If you spot a problem with devfile alizer, [search if an issue already exists](https://github.com/devfile/api/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Falizer). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/devfile/api/issues/new/choose). You can tag Alizer related issues with the `/area alizer` text in your issue. From 0a6c660931686a399499c3f14f9be42514786157 Mon Sep 17 00:00:00 2001 From: Theofanis Petkos Date: Tue, 12 Dec 2023 11:16:27 +0000 Subject: [PATCH 3/9] Update CONTRIBUTING.md Co-authored-by: Michael Valdron Signed-off-by: thepetk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08c7e71c..0b96c412 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ The `alizer` repository includes different components: - [CLI](./README.md#cli) - [Alizer Library](./README.md#library-package) -As a result `alizer` can be used both as a cli tool and imported as a package inside other projects. More information for the repository can be found [here](./docs/public/alizer-spec.md) +As a result, `alizer` can be used both as a cli tool and imported as a package inside other projects. More information for the repository can be found [here](./docs/public/alizer-spec.md). #### Building locally From af6fd7b13040b0022236605feb6ad242e2a86c34 Mon Sep 17 00:00:00 2001 From: Theofanis Petkos Date: Tue, 12 Dec 2023 11:16:37 +0000 Subject: [PATCH 4/9] Update CONTRIBUTING.md Co-authored-by: Michael Valdron Signed-off-by: thepetk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b96c412..a9dd35c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thank you for your interest in contributing to Alizer! We welcome your additions ## Code of Conduct -Before contributing to this repository for the first time, please review our project's [Code of Conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md) +Before contributing to this repository for the first time, please review our project's [Code of Conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md). ## Certificate of Origin From a1bc60af06fb2dad28ba7a2322288f4a7b2e70e5 Mon Sep 17 00:00:00 2001 From: Theofanis Petkos Date: Tue, 12 Dec 2023 11:17:02 +0000 Subject: [PATCH 5/9] Update CONTRIBUTING.md Co-authored-by: Michael Valdron Signed-off-by: thepetk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9dd35c8..4ad73411 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ As a result, `alizer` can be used both as a cli tool and imported as a package i #### Building locally -More information for building & running locally the project can be found [here](./README.md#usage) +More information for building & running locally the project can be found [here](./README.md#usage). #### Testing From f795e94bd6725d0c53b5708ede39e91f2292661e Mon Sep 17 00:00:00 2001 From: Theofanis Petkos Date: Tue, 12 Dec 2023 11:18:23 +0000 Subject: [PATCH 6/9] Update CONTRIBUTING.md Co-authored-by: Michael Valdron Signed-off-by: thepetk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ad73411..aa8ce187 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,4 +60,4 @@ After addressing review comments, don't forget to add a comment in the PR afterw # Contact us -If you have questions, please visit us on `#devfile` in the [Kubernetes Slack](https://slack.k8s.io). +If you have any questions, please visit us the `#devfile` channel under the [Kubernetes Slack](https://slack.k8s.io) workspace. From 30093b3ee6955f020110fb39569b08db7a3d119d Mon Sep 17 00:00:00 2001 From: Theofanis Petkos Date: Tue, 12 Dec 2023 11:18:50 +0000 Subject: [PATCH 7/9] Update CONTRIBUTING.md Co-authored-by: Michael Valdron Signed-off-by: thepetk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa8ce187..614e337b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,7 +56,7 @@ By default for each change in the PR, GitHub Actions and OpenShift CI will run c If comments have been given in a review, they have to be addressed before merging. -After addressing review comments, don't forget to add a comment in the PR afterward, so everyone gets notified by Github and know to re-review. +After addressing review comments, don't forget to add a comment in the PR with the reviewer mentioned afterward, so they get notified by Github to provide a re-review. # Contact us From b6ce6d89c3777da9a9410ca901a6f8d0a2ab9e4b Mon Sep 17 00:00:00 2001 From: Theofanis Petkos Date: Tue, 12 Dec 2023 11:19:09 +0000 Subject: [PATCH 8/9] Update CONTRIBUTING.md Co-authored-by: Michael Valdron Signed-off-by: thepetk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 614e337b..df044fef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,7 @@ Signed-off-by: First Lastname You can easily add this footer to your commits by adding `-s` when running `git commit`. When you think the code is ready for review, create a pull request and link the issue associated with it. -Owners of the repository will watch out for and review new PRs. +Owners of the repository will watch out for new PRs and provide reviews to them. By default for each change in the PR, GitHub Actions and OpenShift CI will run checks against your changes (linting, unit testing, and integration tests). From 9f6ed9e0c6627bb354dbbb7ee5f6a4d9b5aac794 Mon Sep 17 00:00:00 2001 From: thepetk Date: Tue, 12 Dec 2023 11:21:34 +0000 Subject: [PATCH 9/9] Update contributing.md Signed-off-by: thepetk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df044fef..e5be9325 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ You can easily add this footer to your commits by adding `-s` when running `git Owners of the repository will watch out for new PRs and provide reviews to them. -By default for each change in the PR, GitHub Actions and OpenShift CI will run checks against your changes (linting, unit testing, and integration tests). +For each change in the PR, GitHub Actions will run by default checks against your changes (linting, unit testing and code coverage). If comments have been given in a review, they have to be addressed before merging.