Skip to content

Commit

Permalink
Merge pull request #28 from compsci-adl/issue-templates
Browse files Browse the repository at this point in the history
Add issue and PR templates
  • Loading branch information
phoenixpereira authored Jan 19, 2024
2 parents 302306d + 3e1b68f commit 8e332f8
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 0 deletions.
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

0 comments on commit 8e332f8

Please sign in to comment.