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

Issue Templates #47

Merged
merged 3 commits into from
Oct 25, 2022
Merged
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
32 changes: 7 additions & 25 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug Report
description: Please file a bug report to help us improve the CHAOSS Bot
description: Please file a bug report to help us improve the project
title: "[Bug]: Short description of the problem"
labels: ["bug"]

Expand Down Expand Up @@ -46,7 +46,11 @@ body:
attributes:
label: Steps to Reproduce the Behavior
description: Please share with us a minimalistic template to reproduce the bug.
placeholder: e.g 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error
placeholder: |
1. In this environment...
2. With this config...
3. Run/Click on '....'
4. See error
validations:
required: true
- type: textarea
Expand All @@ -68,26 +72,4 @@ body:
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/chaoss/chaoss-slack-bot/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

# **Bug description**
# Please explain what is wrong with the CHAOSS Slack Bot

# **Your environment**
# Please provide the following information:
# - Operating System: [e.g. Windows 10, Ubuntu 18.04, macOS 10.14.6]

# **Steps to reproduce the behavior**
# Please share with us a minimalistic template to reproduce the bug.

# **Expected behavior**
# A clear and concise description of what you expected to happen.

# **What went wrong?**
# What happened instead? What error message did you get?

# **Screenshots**
# If applicable, add screenshots to help explain your problem.

# **Additional context**
# Add any other context about the problem here.
required: true
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Feature Request
description: Suggest an idea for this project
title: "[Feature]: Short description of the feature"
labels: ["enhancement"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: eg. [email protected]
validations:
required: false
- type: textarea
id: problem
attributes:
label: The Problem
description: What problem do you hope to solve with this feature?
placeholder: e.g. Our Slack Bot has the feature to send site-wide DMs to all the members of the CHAOSS slack channel. I would love to activate this feature for sending our community survey.
validations:
required: true
- type: textarea
id: fix
attributes:
label: How to Fix It
description: What do you think needs to be done to fix this problem?
placeholder: e.g. Check the app.js file and go to line 114; there is a DM set up...
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any other context about the feature request here (links, screenshots, text, etc).
placeholder: |
e.g. Message to add in the line of code:
Hello there! We recently launched a community survey to get your feedback...
- type: textarea
id: path
attributes:
label: Specific File Path(s) on the Repo to be Modified/Refered to
description: Please share the specific file path(s) to be modified/refered to in the codebase.
placeholder: |
e.g. https://github.com/chaoss/chaoss-slack-bot/blob/main/app.js
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/chaoss/chaoss-slack-bot/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
This PR...

## Changes

-

## Screenshots

(prefer animated gif)

## Checklist

- [ ] tested locally
- [ ] added new dependencies
- [ ] updated the docs
- [ ] added a test

Fixes #