This is an automated email from the ASF dual-hosted git repository. duanzhengqiang pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/shardingsphere-on-cloud.git
commit 80c2983f23aa9a2b518a06559d8088d3daaa0404 Author: Ghoul_Lee <[email protected]> AuthorDate: Fri May 13 16:46:28 2022 +0800 ADD: PR && ISSUE && REQUEST template (#9) * ADD: PR && ISSUE && REQUEST template * ADD: add emoji --- .github/ISSUE_TEMPLATE/bug_report.yaml | 38 ++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/request_help.yaml | 21 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE | 27 +++++++++++++++++++++++ CODE_OF_CONDUCT.md | 21 ++++++++++++++++++ 4 files changed, 107 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..556f25e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,38 @@ +name: "🐞 Bug Report" +description: help us to improve ourself +title: "🐞 bug: " +body: + - type: textarea + id: environment + attributes: + label: Environment + description: Bug report without environment information will be ignored or closed. + value: | + - Contents of your values.yaml file,if your helm deployment process goes wrong. + - Contents of your CRD resource file. Include proxy.shardingsphere.sphere-ex.com/v1alpha1 and proxyconfig.shardingsphere.sphere-ex.com/v1alpha1 + - Kubernetes distro (e.g. RKE/K3s/EKS/OpenShift) and version + validations: + required: true + - type: textarea + id: description + attributes: + label: Issue description + description: Please provide a clear description of your problem. + value: | + - Which phase is not functioning properly, is it the installation phase or the apply CRD phase ? + validations: + required: true + - type: textarea + id: Error + attributes: + label: Error log + value: | + - Including ShardingSphere-Proxy error log and ShardingSphere-Operator error log + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected result + description: What's the expected result? + diff --git a/.github/ISSUE_TEMPLATE/request_help.yaml b/.github/ISSUE_TEMPLATE/request_help.yaml new file mode 100644 index 0000000..bda56f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request_help.yaml @@ -0,0 +1,21 @@ +name: "🚀 Request help" +description: Please use this template for requesting help. +title: "🚀 request help: " +body: + - type: textarea + id: description + attributes: + label: Request description + description: Provide a clear and concise description of the help you need. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Request help without environment information will be ignored or closed. + value: | + - your ShardingSphere-Operator Version + - Kubernetes distro (e.g. RKE/K3s/EKS/OpenShift) and version + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 0000000..672398c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,27 @@ +<!-- Please answer these questions before submitting a pull request --> + +### Type of change: + +<!-- Please delete options that are not relevant. --> + +- [ ] Bugfix +- [ ] New feature provided +- [ ] Improve performance +- [ ] Backport patches + +### What this PR does / why we need it: +<!--- Why is this change required? What problem does it solve? --> +<!--- If it fixes an open issue, please link to the issue here. --> + +### Pre-submission checklist: + +<!-- +Please follow the requirements: +1. Test is required for the feat/fix PR, unless you have a good reason +2. Doc is required for the feat PR +3. Use "request review" to notify the reviewer once you have resolved the review +--> + +* [ ] Did you explain what problem does this PR solve? Or what new features have been added? +* [ ] Have you added corresponding test cases? +* [ ] Have you modified the corresponding document? \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c2edd5e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,21 @@ +# Contributor Code of Conduct + +## Our Standards +Examples of behavior that contributes to a positive environment include: + +Demonstrating empathy and kindness toward other people +Being respectful of differing opinions, viewpoints, and experiences +Giving and gracefully accepting constructive feedback +Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +Focusing on what is best not just for us as individuals, but for the overall community +Examples of unacceptable behavior include: + +The use of sexualized language or imagery, and sexual attention or advances of any kind +Trolling, insulting or derogatory comments, and personal or political attacks +Public or private harassment +Publishing others' private information, such as a physical or email address, without their explicit permission +Other conduct which could reasonably be considered inappropriate in a professional setting +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. + +## Attribution +This Code of Conduct is adapted from the CNCF available at this page https://github.com/cncf/foundation/blob/main/code-of-conduct.md \ No newline at end of file
