Skip to content

Commit

Permalink
add issue and pr template (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
yuluo-yx authored Sep 17, 2023
1 parent 0c34755 commit 91ef68e
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: 📄 Documentation Issue
description: File an issue/update related to documentation
title: "[Docs]: "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to point out documentation issues for spring cloud alibaba!
- type: textarea
id: "current-state"
attributes:
label: Current State
description: Current state of the documentation page with possible links and screenshots
placeholder: The "What is Spring Cloud Alibaba" page does not fully explain...
value: |
**Description of the current issue**:
**Link to the page, allows developers to better identify problems**:
**Screenshots (if relevant)**:
- type: textarea
id: "desired-state"
attributes:
label: Desired State
description: How should the docs look like instead?
placeholder: The page should instead explain...
value: |
**Description of the change you are proposing**:
- type: dropdown
id: "is-working"
attributes:
label: Would you like to fix this issue?
description: You can choose to fix this documentation issue yourself or have another contributor in the community fix it.
options: ["Yes! Please assign to me!", "No. Please assign another contributor"]
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/website.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: 🖥 Website Issue
description: File an issue to update the website
title: "[Site]: "
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to raise questions and update the spring cloud alibaba official website!
- type: textarea
id: "current-state"
attributes:
label: Current State
description: Current state of the website with possible links and screenshots
placeholder: Some of the semantics in the page are unclear...
value: |
**Description of the current state**:
**Link to the wensite page, allow developers to better understand the problem**:
**Screenshots (if relevant)**:
- type: textarea
id: "desired-state"
attributes:
label: Desired State
description: How should the site look like instead?
placeholder: A more reasonable explanation for the relevant entries should be...
value: |
**Description of the change you are proposing**:
- type: dropdown
id: "is-working"
attributes:
label: Would you like to fix this issue?
description: You can choose to fix this issue yourself or let other contributors in the community fix it.
options: ["Yes! Please assign to me!", "No. Please assign another contributor"]
9 changes: 9 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Fixes: #[Add issue number here]

Changes:

<!-- Add here what changes were made in this pull request and if possible provide links showcasing the changes. -->

Screenshots of the change:

<!-- Add screenshots depicting the changes. -->

0 comments on commit 91ef68e

Please sign in to comment.