diff options
author | Joe Chen <jc@unknwon.io> | 2021-12-17 18:13:21 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-12-17 18:13:21 +0800 |
commit | 55070da23956752f19985fb5e06bae8cd9d977db (patch) | |
tree | c38b831dfa682af097c23658a343e59141095ab0 /.github | |
parent | 6f2b7fb8531ac6a500a8f90f88dff8e479a76840 (diff) |
github: refurbish issue and pull request templates (#6664)
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 65 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 81 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 6 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/documentation.yml | 31 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 32 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yml | 46 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/security.md | 12 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 8 | ||||
-rw-r--r-- | .github/dependabot.yml | 11 | ||||
-rw-r--r-- | .github/pull_request_template.md | 11 |
10 files changed, 183 insertions, 120 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3f504ea0..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -name: Bug report -about: Report problems and unexpected behavior - ---- - -<!-- - -First of all, please read https://www.chiark.greenend.org.uk/~sgtatham/bugs.html. - -If you don't want to read, it's up to you. But don't waste your time continue reporting. - -The issue will be closed without any explanation if it does not satisfy any of following requirements: - -1. Please speak English, we have forum in 中文: https://discuss.gogs.io/c/getting-help/getting-help-chinese. -2. Please post any questions, configuration or deploy problems on our forum: https://discuss.gogs.io. -3. Please do not end your title with a question mark or period. -4. Please take a moment to search and make sure the issue doesn't already exist. -5. Please give all relevant information below for bug reports; incomplete details are considered invalid report. - ---> - -**Describe the bug** -<!-- A clear and concise description of what the bug is --> - -**Gogs version and commit** -<!-- - The version number or the commit SHA of the Gogs instance you use. - You can find these information in the admin dashboard ("/admin"). ---> - -**Git version** - -``` -$ git version - -``` - -**Operating system** -<!-- The name and version of your operating system --> - -**Database** -<!-- The database and version you use --> - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Can you reproduce the bug at https://try.gogs.io?** -<!-- If yes, please provide the example URL; if no, please explain why --> - -**Expected behavior** -<!-- A clear and concise description of what you expected to happen --> - -**Actual behavior** -<!-- A clear and concise description of what you see instead --> - -**Screenshots** -<!-- If applicable, add screenshots to help explain your problem --> - -**Additional context** -<!-- Please include any error logs found in `log/gogs.log` --> diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..e7c7b7bd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,81 @@ +name: Bug report +description: File a bug report to help us improve +labels: ["\U0001F48A bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - For questions, ask in [Discussions](https://github.com/gogs/gogs/discussions). + - Before you file an issue read the [Contributing guide](https://github.com/gogs/gogs/blob/main/.github/contributing.md). + - Check to make sure someone hasn't already opened a similar [issue](https://github.com/gogs/gogs/issues). + - type: input + attributes: + label: Gogs version + description: | + Please specify the exact Gogs version you're reporting for. You can find the version information in the admin dashboard (`/admin`). + + _Note that "gogs/gogs:latest" is not a Gogs version, it does not mean anything._ + validations: + required: true + - type: textarea + attributes: + label: Git version + description: | + Please specify the exact Git version you're using of both server and client. You can get the version information by running `git version`. + value: | + - Server: + - Client: + validations: + required: true + - type: input + attributes: + label: Operating system + description: | + Please specify the exact operating system name and version you're reporting for, e.g. "Windows 10", "CentOS 7", "Ubuntu 20.04". + validations: + required: true + - type: input + attributes: + label: Database + description: | + Please specify the exact database and version you're reporting for, e.g. "PostgreSQL 9.6", "MySQL 5.7", "SQLite 3". + validations: + required: true + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + attributes: + label: To reproduce + description: The steps to reproduce the problem described above. + validations: + required: true + - type: textarea + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Additional context + description: | + Links? References? Suggestions? Anything that will give us more context about the issue you are encountering! + + Please include any error logs found in the `log/gogs.log` file. Otherwise, we probably won't be able to help you much. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: checkboxes + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://go.dev/conduct) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 6692287b..68a3b2b5 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - - name: Gogs Community Forum - url: https://discuss.gogs.io/ - about: Please ask and answer questions here. + - name: Ask questions + url: https://github.com/gogs/gogs/discussions + about: Please ask questions in Discussions. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..8481d3de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,31 @@ +name: Improve documentation +description: Suggest an idea or a patch for documentation +labels: ["📖 documentation"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this form! + + - For questions, ask in [Discussions](https://github.com/gogs/gogs/discussions). + - Before you file an issue read the [Contributing guide](https://github.com/gogs/gogs/blob/main/.github/contributing.md). + - Check to make sure someone hasn't already opened a similar [issue](https://github.com/gogs/gogs/issues). + - type: textarea + attributes: + label: What needs to improved? Please describe + description: A clear and concise description of what is wrong or missing. + validations: + required: true + - type: textarea + attributes: + label: Why do you think it is important? + description: A clear and concise explanation of the rationale. + validations: + required: true + - type: checkboxes + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://go.dev/conduct) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 95f992aa..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -<!-- - -First of all, please read https://www.chiark.greenend.org.uk/~sgtatham/bugs.html. - -If you don't want to read, it's up to you. But don't waste your time continue reporting. - -The issue will be closed without any explanation if it does not satisfy any of following requirements: - -1. Please speak English, we have forum in 中文: https://discuss.gogs.io/c/getting-help/getting-help-chinese. -2. Please post any questions, configuration or deploy problems on our forum: https://discuss.gogs.io. -3. Please do not end your title with a question mark or period. -4. Please take a moment to search and make sure the issue doesn't already exist. - ---> - -**Describe the feature** -<!-- A description of what feature you would like --> - -**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 --> diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..6fe2bfea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,46 @@ +name: Feature request +description: Suggest an idea for this project +labels: ["\U0001F3AF feature"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this form! + + - For questions, ask in [Discussions](https://github.com/gogs/gogs/discussions). + - Before you file an issue read the [Contributing guide](https://github.com/gogs/gogs/blob/main/.github/contributing.md). + - Check to make sure someone hasn't already opened a similar [issue](https://github.com/gogs/gogs/issues). + - type: textarea + attributes: + label: Describe the feature + description: A clear and concise description of what the feature is, e.g. I think it is reasonable to have [...] + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + attributes: + label: Additional context + description: | + Links? References? Suggestions? Anything that will give us more context about the feature you are requesting! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: checkboxes + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://go.dev/conduct) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/security.md b/.github/ISSUE_TEMPLATE/security.md deleted file mode 100644 index ebb82e0a..00000000 --- a/.github/ISSUE_TEMPLATE/security.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: Security vulnerability -about: Report security vulnerability for this project - ---- - -<!-- - -Please create a dummy issue with high-level description of the security vulnerability, -then report details to security@gogs.io privately, thank you! - ---> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7132e8e4..00000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,8 +0,0 @@ -The pull request will be closed without any reasons if it does not satisfy any of following requirements: - -1. Please read contributing guidelines: -https://github.com/gogits/gogs/wiki/Contributing-Code -2. Please describe what your pull request does and which issue you're targeting -3. ... if it is not related to any particular issues, explain why we should not reject your pull request. - -**You MUST delete above content including this line before posting; too lazy to take this action considered invalid pull request.** diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..ee0c88ac --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# Docs: https://git.io/JCUAY +version: 2 +updates: + - package-ecosystem: "gomod" + directory: "/" + schedule: + interval: "weekly" + reviewers: + - "unknwon" + commit-message: + prefix: "mod:" diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..180d97c8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +### Describe the pull request + +A clear and concise description of what the pull request is about, i.e. what problem should be fixed? + +Link to the issue: <!-- paste the issue link here, or put "n/a" if not applicable --> + +### Checklist + +- [ ] I agree to follow the [Code of Conduct](https://go.dev/conduct) by submitting this pull request. +- [ ] I have read and acknowledge the [Contributing guide](https://github.com/gogs/gogs/blob/main/.github/contributing.md). +- [ ] I have added test cases to cover the new code. |