From 98daa162ad983c5cb13e8f3653a7a73d391a6a77 Mon Sep 17 00:00:00 2001 From: "cheney.yin" Date: Thu, 15 Jun 2023 14:37:29 +0800 Subject: [PATCH 1/2] [Chore] Add contributing in README. --- README.md | 29 ++++++++++++++++++++++++++++- README_cn.md | 29 ++++++++++++++++++++++++++++- 2 files changed, 56 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e9c9ff8..e89ad10 100644 --- a/README.md +++ b/README.md @@ -41,12 +41,39 @@ If you use Metal, you can easily reuse these plugins. Metal provides two ways to ## Architecture [Architecture](/doc/Architecture.md) +## How to Contribute + +Thanks for your interest in contributing! The easiest way is to just send a pull request(PR). Before send a PR, you need to understand how to build the source code and do somethings. + +### Building From source + +Building Metal requires at minimum JDK 11. Pull the latest source from the repository and use Maven install (or package) to build: + +```shell +git pull origin master +mvn clean package -pl metal-dist -am -Dmaven.test.skip=true +``` + +### Before Send a pull request + +Please check code format and fix the `spotless` errors if any: + +```shell +mvn spotless:check +``` + +More details in [Contributing.md](CONTRIBUTING.md). + ## Code of Conduct -[CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) +[CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) +## Security +[Security.md](SECURITY.md) ## Sponsor JetBrains Logo (Main) logo. Thanks to JetBrains for the free license.
## License [Apache 2.0 License.](LICENSE) + + diff --git a/README_cn.md b/README_cn.md index 9fea00c..7278ae9 100644 --- a/README_cn.md +++ b/README_cn.md @@ -41,9 +41,36 @@ Metal是一款数据流建模软件，通过Metal可以管理数据流处理算 ## Architecture [Architecture](/doc/Architecture_cn.md) +## How to Contribute + +感谢您对本项目贡献的兴趣! 了解如何对项目做贡献的最简单的方式是提交一次PR。在正式发起PR前，你需要了解如何构建源码以及提交前的主要事项。 + +### 从源码构建 + +构建Metal，需要使用JDK 11及以上版本。从仓库拉取最新代码，然后使用`maven`执行构建： + +```shell +git pull origin master +mvn clean package -pl metal-dist -am -Dmaven.test.skip=true +``` + +### 提交PR前的注意项 + +通过如下命令检查代码格式: + +```shell +mvn spotless:check +``` + +您需要保证在发起PR前，已经修复了全部`spotless`错误。 + +更多细节见[Contributing.md](CONTRIBUTING.md). + ## Code of Conduct -[CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) +[CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) +## Security +[Security.md](SECURITY.md) ## Sponsor JetBrains Logo (Main) logo. Thanks to JetBrains for the free license.
From 61e192c108b2344ef5ff792dac719e4c2a5dfc3e Mon Sep 17 00:00:00 2001 From: "cheney.yin" Date: Thu, 15 Jun 2023 14:56:19 +0800 Subject: [PATCH 2/2] [Chore] Add issue-template. --- .github/ISSUE_TEMPLATE/bug-report.md | 31 ------ .github/ISSUE_TEMPLATE/bug-report.yml | 124 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 67 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ---- 4 files changed, 191 insertions(+), 51 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index a2e89ed..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Platform (please complete the following information):** - - OS: [e.g. iOS] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..82683ea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,124 @@ +name: Bug report +title: "[Bug][Module Name] Bug title" +description: Problems and issues with code of Metal +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please make sure what you are reporting is indeed a bug with reproducible steps. + For better global communication, Please write in English. + + If you feel the description in English is not clear, then you can append description in Chinese, thanks! + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/CheneyYin/metal/issues?q=is%3Aissue+label%3A%22bug%22) + first to see whether the same issue was reported already. + options: + - label: > + I had searched in the [issues](https://github.com/CheneyYin/metal/issues?q=is%3Aissue+label%3A%22bug%22) and found + no similar issues. + required: true + + - type: textarea + attributes: + label: What happened + description: Describe what happened. + placeholder: > + Please provide the context in which the problem occurred and explain what happened + validations: + required: true + + - type: textarea + attributes: + label: Metal Version + description: Provide Metal version. + placeholder: > + Please provide the version of Metal. + validations: + required: true + + - type: textarea + attributes: + label: Spark Version + description: Provide Spark version. + placeholder: > + Please provide the version of Spark. + validations: + required: true + + - type: textarea + attributes: + label: Metal Spec + description: Provide Metal Spec, please delete sensitive information to prevent information leakage + placeholder: > + Please provide the Metal Spec here. + render: json + validations: + required: true + + - type: textarea + attributes: + label: Running Command + description: Provide the Running Command you begin and run Metal. + placeholder: > + Please provide the running command here. + render: shell + validations: + required: true + + - type: textarea + attributes: + label: Error Exception + description: Provide the error exception when you run your command. + placeholder: > + Please provide the error exception here. + render: log + validations: + required: true + + - type: textarea + attributes: + label: Java or Scala Version + description: Provide Java or Scala Version. + placeholder: > + Please provide the version of Java or Scala. + validations: + required: false + + - type: textarea + attributes: + label: Screenshots + description: Provide the screenshots if necessary. + placeholder: > + Please copy-paste the screenshots here. + validations: + required: false + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + This is absolutely not required, but we are happy to guide you in the contribution process + especially if you already have a good understanding of how to implement the fix. + seatunnel is a totally community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: checkboxes + attributes: + label: Code of Conduct + description: | + The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it. + options: + - label: > + I agree to follow this project's + [Code of Conduct](https://github.com/CheneyYin/metal/blob/master/CODE_OF_CONDUCT.md) + required: true + + - type: markdown + attributes: + value: "Thanks for completing our form, and we will reply you as soon as possible." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..2fd0aba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,67 @@ +name: Feature request +description: Suggest an idea for Metal +title: "[Feature][Module Name] Feature title" +labels: ["Feature"] +body: + - type: markdown + attributes: + value: | + For better global communication, Please write in English. + + If you feel the description in English is not clear, then you can append description in Chinese, thanks! + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [feature](https://github.com/CheneyYin/metal/issues?q=is%3Aissue+label%3A%22Feature%22) first + to see whether the same feature was requested already. + options: + - label: > + I had searched in the [feature](https://github.com/CheneyYin/metal/issues?q=is%3Aissue+label%3A%22Feature%22) and found no + similar feature requirement. + required: true + + - type: textarea + attributes: + label: Description + description: Please describe the function you want in as much detail as possible. + placeholder: > + Rather than telling us how you might implement this feature, try to take a + step back and describe what you are trying to achieve. + validations: + required: true + + - type: textarea + attributes: + label: Usage Scenario + description: Please describe usage scenario of this feature. + + - type: textarea + attributes: + label: Related issues + description: Is there currently another issue associated with this? + + - type: checkboxes + attributes: + label: Are you willing to submit a PR? + description: > + This is absolutely not required, but we are happy to guide you in the contribution process + especially if you already have a good understanding of how to implement the feature. + seatunnel is a totally community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: checkboxes + attributes: + label: Code of Conduct + description: | + The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it. + options: + - label: | + I agree to follow this project's [Code of Conduct](https://github.com/CheneyYin/metal/blob/master/CODE_OF_CONDUCT.md) + required: true + + - type: markdown + attributes: + value: "Thanks for completing our form, and we will reply you as soon as possible." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here.