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: improve issue templates #413

Merged
merged 1 commit into from
Feb 15, 2023
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
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/blank_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
name: 📝 Blank Issue
about: Create a blank issue.
---
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: 🐛 Bug Report
description: Create a bug report
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this bug report!
Please fill out the form below...
- type: textarea
id: description
attributes:
label: Bug Description
description: Please provide a clear and concise description of what the bug is, and what you would expect to happen.
placeholder: The bug is...
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to Reproduce
description: Please provide the steps to reproduce this bug. You can include your code here if it is relevant.
placeholder: |
1.
2.
3.
validations:
required: false
- type: dropdown
id: os
attributes:
label: Your operating system
options:
- Windows
- MacOS
- Linux
- Other (specify below)
validations:
required: false
- type: dropdown
id: py_version
attributes:
label: Your Python version (`python --version`)
options:
- 3.7
- 3.8
- 3.9
- 3.10
- 3.11
- Other (specify below)
validations:
required: false
- type: dropdown
id: robyn_version
attributes:
label: Your Robyn version
options:
- main branch
- latest
- Other (specify below)
validations:
required: false
- type: textarea
id: additional-info
attributes:
label: Additional Info
description: Any additional info that you think might be useful or relevant to this bug
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Discord Community Support
url: https://discord.gg/rkERZ5eNU8
about: You can ask and answer questions here.
- name: Documentation
url: https://sansyrox.github.io/robyn/#/
about: The Robyn documentation.
31 changes: 9 additions & 22 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,14 @@
---
name: 💡 Feature request
about: Suggest an enhancement to Robyn
title: '[Feature Request]'
labels: 'kind/enhancement'
assignees: ''
about: Suggest an idea to improve Robyn
labels: [enhancement]
---

**Current Behavior**
<!--
Thank you for considering improving Robyn!

<!-- A brief description of what the problem is. (e.g. I need to be able to...) -->

**Desired Behavior**

<!-- A brief description of the enhancement. -->

---

**Screenshots / Mockups**

<!-- Add any other context or screenshots about the feature request here. -->

**Alternatives**

<!-- A brief description of any alternative solutions or features you've considered. -->

---
Please describe your idea in depth. If you're not sure what to write, imagine the following:
- How is this important to you? How would you use it?
- Can you think of any alternatives?
- Do you have any ideas about how it can be implemented? Are you willing/able to implement it? Do you need mentoring?
-->