From 29405fd52e1c333ae42d44ba56db12aa70e0db8d Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Tue, 22 Oct 2024 06:28:31 +0200 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/1-report-issue.yml | 20 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/2-new-recipe.yml | 20 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/3-new-chapter.yml | 19 +++++++++++++++++++ .github/ISSUE_TEMPLATE/4-other.yml | 10 ++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 +++++++ 5 files changed, 76 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-report-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/2-new-recipe.yml create mode 100644 .github/ISSUE_TEMPLATE/3-new-chapter.yml create mode 100644 .github/ISSUE_TEMPLATE/4-other.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/1-report-issue.yml b/.github/ISSUE_TEMPLATE/1-report-issue.yml new file mode 100644 index 0000000..a4aba4b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-report-issue.yml @@ -0,0 +1,20 @@ +name: '🐛 Bug report' +labels: 'bug' +description: > + Create a bug report if you see something wrong with the pages + +body: + + - type: input + attributes: + label: Page URL + description: URL of the page where you see the issue. + validations: + required: true + + - type: textarea + attributes: + label: Description + description: Describe the issue and the expected changes + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/2-new-recipe.yml b/.github/ISSUE_TEMPLATE/2-new-recipe.yml new file mode 100644 index 0000000..b3ff77c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-new-recipe.yml @@ -0,0 +1,20 @@ +name: '📝 New Recipe or Use-case' +labels: 'documentation' +description: > + Let us know if any documentation is missing or could be improved. + Any use cases are welcome! + +body: + - type: textarea + attributes: + label: Describe your use-case which is not covered by existing documentation. + description: If it is easier to submit a documentation patch instead of writing an issue, just do it! + validations: + required: true + + - type: textarea + attributes: + label: Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration. + + + diff --git a/.github/ISSUE_TEMPLATE/3-new-chapter.yml b/.github/ISSUE_TEMPLATE/3-new-chapter.yml new file mode 100644 index 0000000..63ace13 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-new-chapter.yml @@ -0,0 +1,19 @@ +name: '📝 New Chapter' +labels: 'documentation' +description: > + Want to propose a new section? + +body: + - type: textarea + attributes: + label: Describe an area which is not yet covered by existing documentation. + validations: + required: true + + - type: textarea + attributes: + label: > + Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration. + + + diff --git a/.github/ISSUE_TEMPLATE/4-other.yml b/.github/ISSUE_TEMPLATE/4-other.yml new file mode 100644 index 0000000..054a6d4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-other.yml @@ -0,0 +1,10 @@ +name: "❓ Other" +description: Free form issue for everything that doesn't fit in the templates above +body: + - type: textarea + attributes: + label: Description + value: | + This is a place of freedom. Enjoy! + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..c6bcf5d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +blank_issues_enabled: false +contact_links: + - name: "🛟 Community Slack" + url: https://community.gradle.org/contributing/community-slack/ + about: > + There is also #community-support channel if you need help. + If you want to share feedback or discuss any changes in the docs, consider joining our the #docs channel.