From dffe21265f50422aa54e1b653472fa9d39270ece Mon Sep 17 00:00:00 2001 From: laxmikantbpandhare Date: Mon, 15 Feb 2021 11:43:53 -0800 Subject: [PATCH 1/3] modified guidelined for the contribution and added compilation steps for java --- CONTRIBUTING.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f704b91..db6c47e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,22 @@ # How to contribute -Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into operator-sdk. +Java Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into java-operator-sdk. + +## Email and Chat + +- Email: [operator-framework][operator_framework] ## Getting started - Fork the repository on GitHub + https://github.com/operator-framework/java-operator.git + +- If you want to build/run the project, use command + mvn clean install ## Reporting bugs and creating issues -Reporting bugs is one of the best ways to contribute. +Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on reporting issues before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug. ## Contribution flow @@ -17,6 +25,8 @@ This is a rough outline of what a contributor's workflow looks like: - Create a topic branch from where to base the contribution. This is usually master. - Make commits of logical units. - Make sure commit messages are in the proper format (see below). +- Check your work after running all Unit and Regression Tests. You should run all the unit tests by hitting the following command + mvn clean install - Push changes in a topic branch to a personal fork of the repository. - Submit a pull request to operator-framework/operator-sdk. - The PR must receive a LGTM from two maintainers found in the MAINTAINERS file. @@ -25,7 +35,7 @@ Thanks for contributing! ### Code style -The coding style suggested by the Golang community is used in operator-sdk. See the [style doc][golang-style-doc] for details. +The coding style suggested by the Golang community is used in operator-sdk. See the [style doc](https://google.github.io/styleguide/javaguide.html) for details. Please follow this style to make operator-sdk easy to review, maintain and develop. @@ -55,6 +65,14 @@ The format can be described more formally as follows: The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools. +### PR Review + +Your PR will get reviewed soon from the maintainers of the project. If they suggest changes, do all the changes, commit the changes, rebase the branch, squash the commits and push the changes. If all will be fine, your PR will be merged. + +That's it! Thank you for your contribution! + +Feel free to suggest changes to this documentation. If you want to discuss something with maintainers, you can ask us on a GitHub [issue](https://github.com/laxmikantbpandhare/java-operator.git) + ## Documentation If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the use of the new or updated feature. \ No newline at end of file From c825b11621b78742f1b9d998b0c9b71c1201275f Mon Sep 17 00:00:00 2001 From: Laxmikant Bhaskar Pandhare <47066536+laxmikantbpandhare@users.noreply.github.com> Date: Mon, 15 Feb 2021 11:47:12 -0800 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db6c47e..249161f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,8 +71,8 @@ Your PR will get reviewed soon from the maintainers of the project. If they sugg That's it! Thank you for your contribution! -Feel free to suggest changes to this documentation. If you want to discuss something with maintainers, you can ask us on a GitHub [issue](https://github.com/laxmikantbpandhare/java-operator.git) +Feel free to suggest changes to this documentation. If you want to discuss something with maintainers, you can ask us on a GitHub [issue](https://github.com/operator-framework/java-operator/issues) ## Documentation -If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the use of the new or updated feature. \ No newline at end of file +If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the use of the new or updated feature. From 3043a465c0f8803cd892ce4ade062e6dc829b4cb Mon Sep 17 00:00:00 2001 From: laxmikantbpandhare Date: Mon, 15 Feb 2021 12:06:43 -0800 Subject: [PATCH 3/3] modified changes according to suggestions --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 249161f..0e18740 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # How to contribute -Java Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into java-operator-sdk. +Java Operator is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into the Java Operator. ## Email and Chat @@ -12,7 +12,7 @@ Java Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pu https://github.com/operator-framework/java-operator.git - If you want to build/run the project, use command - mvn clean install + `TBD` ## Reporting bugs and creating issues @@ -26,7 +26,7 @@ This is a rough outline of what a contributor's workflow looks like: - Make commits of logical units. - Make sure commit messages are in the proper format (see below). - Check your work after running all Unit and Regression Tests. You should run all the unit tests by hitting the following command - mvn clean install + `TBD` - Push changes in a topic branch to a personal fork of the repository. - Submit a pull request to operator-framework/operator-sdk. - The PR must receive a LGTM from two maintainers found in the MAINTAINERS file. @@ -35,7 +35,7 @@ Thanks for contributing! ### Code style -The coding style suggested by the Golang community is used in operator-sdk. See the [style doc](https://google.github.io/styleguide/javaguide.html) for details. +The coding style suggested by the Java community is used in Java operator. See the [style doc](https://google.github.io/styleguide/javaguide.html) for details. Please follow this style to make operator-sdk easy to review, maintain and develop. @@ -67,7 +67,7 @@ The first line is the subject and should be no longer than 70 characters, the se ### PR Review -Your PR will get reviewed soon from the maintainers of the project. If they suggest changes, do all the changes, commit the changes, rebase the branch, squash the commits and push the changes. If all will be fine, your PR will be merged. +Your PR will get reviewed soon from the maintainers of the project. If they suggest changes, do all the changes, commit the changes, rebase the branch, squash the commits and push the changes. If all is fine, your PR will be merged. That's it! Thank you for your contribution!