Skip to content

Commit

Permalink
Merge pull request #11 from gradle/issue-templates
Browse files Browse the repository at this point in the history
Add issue templates
  • Loading branch information
oleg-nenashev authored Oct 22, 2024
2 parents bc2a7c5 + 29405fd commit 8fa8f40
Show file tree
Hide file tree
Showing 5 changed files with 76 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/1-report-issue.yml
Original file line number Diff line number Diff line change
@@ -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
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/2-new-recipe.yml
Original file line number Diff line number Diff line change
@@ -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.



19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/3-new-chapter.yml
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/4-other.yml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 8fa8f40

Please sign in to comment.