Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore/update for new issue templates format and main repo README badges #1400

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/1-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: 💡 Feature Request
description: Submit a new feature request for Greenwood.
title: "Support x in Greenwood"
labels: ["feature"]
body:
- type: markdown
attributes:
value: |
Thanks for submitting a feature request to Greenwood!
- type: textarea
id: summary
attributes:
label: Motivation
description: Please provide a summary of the feature you are requesting and use case(s).
placeholder: It would be great if Greenwood could do...
validations:
required: true
- type: textarea
id: Motivation
attributes:
label: Technical Design
description: Detail usage within a Greenwood project and the API design you have in mind.
placeholder: I want to use the feature like this...
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Please provide any additional details, links, or resources that may be helpful for consideration of this feature.
validations:
required: false
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/2-enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: ✨ Enhancement
description: Improve an existing feature in Greenwood
title: "Refactor Feature x to use..."
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for wanting to improve Greenwood!
- type: textarea
id: current-state
attributes:
label: Current State
description: Please provide a summary of the current state of a feature or capability of Greenwood.
placeholder: Currently feature x works like this...
validations:
required: true
- type: textarea
id: desired-state
attributes:
label: Desired State
description: Describe what the desired state could look like.
placeholder: Feature x could work like this instead...
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Please provide any additional details, links, or resources that may be helpful for consideration of this enhancement.
validations:
required: false
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/3-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: 🐛 Bug Report
description: File a bug report.
title: "Description of the issue"
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Please provide a summary of the issue or error you are seeing.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Steps to reproduce
description: Please provide a set of steps to reproduce the issue and ideally a link to a minimal reproduction.
placeholder: |
1. I installed x
2. I added y
3. I ran z
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Please provide details of the environment your running in.
placeholder: Greenwood version, operating system, runtime version, browser, etc
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Please provide any additional relevant details, screenshots, links, or resources that would be helpful.
validations:
required: false
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/4-chore.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: ⚙️ Chore
description: Technical tasks not related to Greenwood
title: "Update repo configuration, maintaining dependencies, etc"
labels: ["chore"]
body:
- type: markdown
attributes:
value: |
Thanks for helping out!
- type: textarea
id: task
attributes:
label: Task
description: Description of the task at hand
placeholder: Update ESLint config, change test runner, etc...
validations:
required: true
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
blank_issues_enabled: false

contact_links:
- name: GitHub Discussions
url: https://github.com/ProjectEvergreen/greenwood/discussions
about: Please ask and answer questions here or discuss new ideas for the project.
- name: Discord
url: https://www.greenwoodjs.dev/discord/
about: Chat about Greenwood and join the community!
- name: Documentation
url: https://github.com/ProjectEvergreen/www.greenwoodjs.dev
about: See an issue with the documentation? Visit our website repo to help get it fixed!
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Greenwood
[![Netlify Status](https://api.netlify.com/api/v1/badges/6758148c-5c38-44d8-b908-ca0a1dad0f7c/deploy-status)](https://app.netlify.com/sites/elastic-blackwell-3aef44/deploys)
[![GitHub release](https://img.shields.io/github/tag/ProjectEvergreen/greenwood.svg)](https://github.com/ProjectEvergreen/greenwood/tags)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/ProjectEvergreen/greenwood/master/LICENSE.md)
[![GitHub release](https://img.shields.io/github/tag/ProjectEvergreen/greenwood.svg)](https://github.com/ProjectEvergreen/greenwood/tags)
[![NodeJS compatibility](https://img.shields.io/node/v/@greenwood/cli.svg)](https://nodejs.org/en/about/previous-releases")
[![Discord Chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://www.greenwoodjs.dev/discord/)

## Overview

Expand Down