Skip to content

Commit

Permalink
Updated the issue templates (#181)
Browse files Browse the repository at this point in the history
Updated the issue templates to look like a modern standards
  • Loading branch information
ansulagrawal authored Nov 12, 2024
2 parents a527ef9 + 3e5c5b1 commit b1d829a
Show file tree
Hide file tree
Showing 4 changed files with 151 additions and 68 deletions.
66 changes: 52 additions & 14 deletions .github/ISSUE_TEMPLATE/ask-question.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,63 @@
name: Ask question
description: Ask react-big-schedule related question
labels: [question]
name: Question about react-big-schedule
description: Get help with using react-big-schedule
labels: [question, help-wanted]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to ask a question! Let's make sure we have all the information needed to help you.
- type: checkboxes
id: checklist
id: prerequisites
attributes:
label: Checklist
label: Before asking
description: Please confirm these items before proceeding
options:
- label: I've looked through the [README](https://github.com/react-scheduler/react-big-schedule#readme)
- label: I have read the [documentation](https://github.com/react-scheduler/react-big-schedule#readme) thoroughly
required: true
- label: I've verified that I am running react-big-schedule latest version.
- label: I have searched existing issues and discussions for similar questions
required: true
- label: I've searched the existing issues and discussions for a similar question
- label: I've provided relevant code snippets or error messages
- label: I've included steps to reproduce the issue
- label: I've checked the browser console for any errors
- label: I've tested the issue with the latest version of react-big-schedule

- type: dropdown
id: category
attributes:
label: Question Category
description: What aspect of react-big-schedule is your question about?
options:
- Installation & Setup
- Configuration & Props
- Styling & Customization
- Event Handling
- Performance
- Other
validations:
required: true

- type: textarea
id: question
attributes:
label: Please make sure the question is worded well enough to be understood
placeholder: Provide any additional information and as much context and examples as possible
label: Your Question
description: What would you like to know about react-big-schedule?
placeholder: Please be as specific as possible and include any relevant code snippets or screenshots
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Please provide your environment details
value: |
- react-big-schedule version:
- React version:
- Browser:
- Operating System:
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, code snippets, or screenshots about your question here
placeholder: Include error messages, console logs, or relevant code that might help us understand your question better
94 changes: 64 additions & 30 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,70 +1,104 @@
name: Bug report
description: Report a bug
labels: [triage, bug]
name: Bug Report
description: Report a bug in react-big-schedule
labels: [bug, needs-triage]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out this form as completely as possible.
- type: checkboxes
id: checklist
id: prerequisites
attributes:
label: Checklist
label: Before Submitting
description: Please confirm these items before proceeding
options:
- label: "I've verified that I'm running react-big-schedule latest version."
- label: I have searched existing issues for similar bugs
required: true

- type: textarea
id: description
attributes:
label: Describe the bug
placeholder: A clear and concise description of what the bug is.
label: Bug Description
description: What happened? What did you expect to happen?
placeholder: Provide a clear and concise description of the bug
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction Link/Code
label: Reproduction
description: Help us reproduce the issue
placeholder: |
Please add an example code or a reproduction link that can be used to reproduce the bug
Please provide either:
1. A minimal code example that reproduces the bug
2. A link to a repository or sandbox demonstrating the issue
validations:
required: true

- type: textarea
id: howtoreproduce
id: steps
attributes:
label: Steps to reproduce
label: Steps to Reproduce
description: List the exact steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
2. Click on '...'
3. Scroll to '...'
4. Observe error
validations:
required: true
- type: input
id: operating_system

- type: dropdown
id: browsers
attributes:
label: Operating System
placeholder: Enter your operating system
label: Browser
description: Which browsers have you seen the problem on?
multiple: true
options:
- Chrome
- Firefox
- Safari
- Edge
- Other
validations:
required: true

- type: input
id: browser
id: operating_system
attributes:
label: Browser
placeholder: Enter your browser
label: Operating System
description: What operating system are you using?
placeholder: e.g., Windows 11, macOS 13.0, Ubuntu 22.04
validations:
required: true

- type: input
id: react_version
attributes:
label: React version
placeholder: Enter your React version
label: React Version
description: What version of React are you using?
placeholder: e.g., 18.2.0
validations:
required: true

- type: input
id: schedule_version
id: package_version
attributes:
label: react-big-schedule version
placeholder: Enter your react-big-schedule version
label: react-big-schedule Version
description: What version of react-big-schedule are you using?
placeholder: e.g., 4.4.3
validations:
required: true

- type: textarea
id: additionalinfo
id: additional_context
attributes:
label: Additional Information
placeholder: Add any additional information about the bug here.
label: Additional Context
description: Add any other relevant context about the problem
placeholder: |
- Console errors or logs
- Related issues
- Screenshots or recordings
- Special configurations
55 changes: 33 additions & 22 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,51 +1,62 @@
name: Feature request
description: Request a new functionality
labels: [triage, enhancement]
name: Feature Request
description: Suggest a new feature or enhancement for react-big-schedule
labels: [enhancement, needs-review]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a new feature! Please fill out this form as completely as possible.
- type: checkboxes
id: checklist
id: prerequisites
attributes:
label: Checklist
label: Before Submitting
description: Please confirm these items before proceeding
options:
- label: I've looked through the [README](https://github.com/react-scheduler/react-big-schedule#readme)
- label: I have read the [documentation](https://github.com/react-scheduler/react-big-schedule#readme)
required: true
- label: I've verified that I'm running react-big-schedule latest version.
required: true
- label: I've searched existing feature requests and confirmed that this request is not a duplicate
- label: I have searched existing feature requests to avoid duplicates
required: true

- type: textarea
id: description
id: problem
attributes:
label: What problem does this feature solve?
placeholder: Explain your use case, context, and rationale behind this feature request
label: Problem Statement
description: What problem or use case does this feature address?
placeholder: Describe the specific challenge or limitation you're facing
validations:
required: true

- type: textarea
id: proposed-solution
id: solution
attributes:
label: Proposed Solution
placeholder: Explain your proposed solution and how it would address the problem
description: How do you envision this feature working?
placeholder: Provide a detailed description of your proposed solution, including any API changes or new functionality
validations:
required: true

- type: textarea
id: benefits
id: impact
attributes:
label: Benefits
placeholder: Describe the benefits and impact of implementing this feature
label: Expected Impact
description: How would this feature benefit users?
placeholder: Explain the value this feature would add and who would benefit from it
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
placeholder: List any alternatives you have considered or evaluated
label: Alternative Solutions
description: What alternatives have you considered?
placeholder: Describe any alternative approaches or workarounds you've explored
validations:
required: false

- type: textarea
id: additional-info
id: context
attributes:
label: Additional Information
placeholder: Include any additional information or context that might be useful
label: Additional Context
description: Any other relevant information?
placeholder: Add any other context, mockups, or examples that help explain your feature request
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ We take the security of react-big-schedule seriously. If you believe you have fo

| Version | Supported |
| --------| --------- |
| 4.3.2 or grater | :white_check_mark: |
| 4.2.5 | :white_check_mark: |
| 4.4.3 or grater | :white_check_mark: |
| 4.4.1 | :white_check_mark: |
| rest all | :x: |

Please note that only the latest version of react-big-schedule will receive security updates. It is highly recommended to keep your dependencies up to date.
Expand Down

0 comments on commit b1d829a

Please sign in to comment.