Skip to content

Commit 6169894

Browse files
thescientist13thescientist13
authored
chore/new GitHub issue templates format (#181)
1 parent f065de9 commit 6169894

8 files changed

Lines changed: 153 additions & 7 deletions

File tree

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/1-documentation.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 📚 Documentation and Guides
2+
description: Documentation or Guide's related content.
3+
title: "Document feature x of Greenwood..."
4+
labels: ["docs", "guides"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping out to improve the Greenwood website!
10+
- type: textarea
11+
id: summary
12+
attributes:
13+
label: Summary
14+
description: Please provide a summary of the documentation changes needed.
15+
placeholder: Need to document new feature x added in the latest version of Greenwood.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: additional-details
20+
attributes:
21+
label: Additional Details
22+
description: Please provide any additional details, links, code snippets, or resources that may provide useful context.
23+
validations:
24+
required: false
25+
- type: input
26+
id: greenwood-issue
27+
attributes:
28+
label: Greenwood Issue
29+
description: A link to a relevant Greenwood GitHub issue.
30+
placeholder: ex. https://github.com/ProjectEvergreen/greenwood/1111
31+
validations:
32+
required: false

‎.github/ISSUE_TEMPLATE/2-content.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: ✍️ Content
2+
description: Submit a new blog post or content related change to the website.
3+
title: "Blog post about..."
4+
labels: ["content"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping out to improve the Greenwood website!
10+
- type: textarea
11+
id: summary
12+
attributes:
13+
label: Summary
14+
description: Please provide a summary of the content changes desired.
15+
placeholder: Need to write a blog post about the latest version of Greenwood.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: additional-details
20+
attributes:
21+
label: Additional Details
22+
description: Please provide any additional details, outline, or links to be considered.
23+
validations:
24+
required: false

‎.github/ISSUE_TEMPLATE/3-enhancement.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: ✨ Enhancement
2+
description: New features or enhancements to the website itself.
3+
title: "Add light / dark mode toggle"
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping out to improve the Greenwood website!
10+
- type: textarea
11+
id: summary
12+
attributes:
13+
label: Summary
14+
description: Please provide a summary of the current state of the website and what you would like updated about it.
15+
placeholder: The website should have...
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: additional-context
20+
attributes:
21+
label: Additional Context
22+
description: Please provide any additional details, links, or resources that may be helpful for consideration of this enhancement.
23+
validations:
24+
required: false

‎.github/ISSUE_TEMPLATE/4-bug-report.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 🐛 Bug
2+
description: Something isn't working with the website.
3+
title: "The social links in the header are broken"
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping out to improve the Greenwood website!
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: What happened?
14+
description: Please provide a summary of the issue or error you are seeing, including error messages and screenshots
15+
placeholder: Tell us what you see!
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: reproduction-steps
20+
attributes:
21+
label: Steps to reproduce
22+
description: Please provide a set of steps to reproduce the issue.
23+
placeholder: |
24+
1. I went to the home page
25+
2. I clicked on ...
26+
3. etc
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: environment
31+
attributes:
32+
label: Environment
33+
description: Please provide details of the environment you're running in.
34+
placeholder: Browser, operating system, etc
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: additional-context
39+
attributes:
40+
label: Additional Context
41+
description: Please provide any additional relevant details, screenshots, links, or resources that would be helpful.
42+
validations:
43+
required: false

‎.github/ISSUE_TEMPLATE/5-chore.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: ⚙️ Chore
2+
description: Technical tasks not related to Greenwood
3+
title: "Update repo configuration, maintaining dependencies, etc"
4+
labels: ["chore"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping out to improve the Greenwood website!
10+
- type: textarea
11+
id: task
12+
attributes:
13+
label: Task
14+
description: Description of the task at hand
15+
placeholder: Update ESLint config, change test runner, hosting, etc...
16+
validations:
17+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: GitHub Discussions
5+
url: https://github.com/ProjectEvergreen/greenwood/discussions
6+
about: Have ideas or questions for the website, or creating showcases and templates for Greenwood? Start a conversation!
7+
- name: Discord
8+
url: https://www.greenwoodjs.dev/discord/
9+
about: Chat about Greenwood and join the community!
10+
- name: Greenwood GitHub
11+
url: https://github.com/ProjectEvergreen/greenwood
12+
about: Visit the Greenwood repo if you have an issue or question about Greenwood itself.

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# www.greenwoodjs.dev
22

33
[![Netlify Status](https://api.netlify.com/api/v1/badges/c7837ab5-866a-4bdf-b538-5adbd17d2a20/deploy-status)](https://app.netlify.com/sites/super-tapioca-5987ce/deploys)
4+
[![Discord Chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://www.greenwoodjs.dev/discord/)
45

56
Documentation website for [**GreenwoodJS**](https://www.greenwoodjs.dev/), using GreenwoodJS for development, naturally. Site is hosted on Netlify.
67

0 commit comments

Comments
 (0)