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

Add issue and PR templates #28

Merged
merged 6 commits into from
Jan 19, 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
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Bug Report
description: File a bug report
title: '[Bug]'

body:
- type: textarea
attributes:
label: Description of the Bug
description: What's the issue you encountered?
validations:
required: true

- type: textarea
attributes:
label: Reproduction Steps
description: How can the issue be reproduced?
validations:
required: true

- type: textarea
attributes:
label: Expected Behaviour
description: What do you expect to happen?
validations:
required: true

- type: input
attributes:
label: OS
placeholder: 'e.g. Windows 11'
validations:
required: true

- type: input
attributes:
label: Browser
placeholder: 'e.g. Chrome'
validations:
required: false

- type: input
attributes:
label: Device
placeholder: 'e.g. iPhone 15'
validations:
required: false

- type: textarea
attributes:
label: Additional Notes
description: Add any other notes or screenshots about the bug here.
validations:
required: false
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: Suggest a new feature for the CS Club website.

body:
- type: textarea
attributes:
label: Overview
description: Include the basic, high-level concepts for this feature here.
validations:
required: true

- type: textarea
attributes:
label: Details
description: These may include specific methods of implementation, design considerations, or any other technical details.
validations:
required: true

- type: textarea
attributes:
label: Why would this feature be useful?
description: A clear and concise description of why this feature would improve the CS Club website.
validations:
required: true

- type: textarea
attributes:
label: Additional Notes
description: Add any other notes or screenshots about the feature request here.
validations:
required: false
34 changes: 34 additions & 0 deletions .github/pull_request_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Pull Request
about: Create a pull request.
title: '[Pull Request]'

---
body:
- type: textarea
attributes:
label: Description
description: Briefly describe the purpose of this pull request.
validations:
required: true

- type: textarea
attributes:
label: Changes Made
description: Provide a list of changes made in this pull request.
validations:
required: true

- type: textarea
attributes:
label: Related Issues
description: Reference any related issues using keywords like "Fixes #issue-number".
validations:
required: false

- type: textarea
attributes:
label: Additional Notes
description: Add any other notes or screenshots that might be helpful for the reviewers.
validations:
required: false