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

Resolve: Templates for issues and pull requests #63

Merged
merged 5 commits into from
Sep 22, 2024
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
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Bug Report
description: File a bug report.
labels: ["bug"]
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please make sure this won't be a duplicate.
- type: textarea
id: what-happened
attributes:
label: What happened?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: What was expected?
placeholder: Tell us what you expected!
value: "X didn't work!"
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output.
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
validations:
required: false
- type: textarea
id: more
attributes:
label: Anything you'd like to reference?
description: Please add any links or references to this issue that could be of help.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature Request
description: File a feature request.
labels: ["enhancement"]
title: "[Enhancement]: "
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this form!
Please make sure this won't a duplicate.
- type: checkboxes
attributes:
label: Type
description: |
Please specify the nature of feature you're requesting.
If not sure, check 'others'.
options:
- label: Documentation
required: false
- label: Codebase
- label: UI/UX
- label: Others
- type: textarea
attributes:
label: Feature(s).
description: Mention what you'd like to suggest.
placeholder: For eg:Add a section for blogs.
- type: textarea
attributes:
label: Additional context.
description: Anything you'd like to add that'll help us?
21 changes: 21 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
**Remove anything that's not been modified from this template.**

## Checklist
- [ ] Documentation is updated if necessary.
- [ ] The change(s) has/have been tested locally.

## Description
A brief summary of the changes introduced in this pull request.

## Changes Made
- Main Change 1: Short description
- Main Change 2: Short description

## Related Issues
Closes #issue-number

## Notes for Reviewers(Optional)
Any additional context or insights for the reviewer.

## Screenshots / Media (Optional)
If applicable, insert images or videos demonstrating the changes.
Loading