Skip to content

Commit

Permalink
Add templates for issues and pull requests.
Browse files Browse the repository at this point in the history
  • Loading branch information
GrahamDumpleton committed Aug 14, 2023
1 parent 69c7394 commit 1670019
Show file tree
Hide file tree
Showing 4 changed files with 131 additions and 1 deletion.
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: Use this template when creating a bug report.
labels:
- bug

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: project-version
attributes:
label: Project version
description: What version of this project are you using?
validations:
required: true

- type: textarea
id: describe-bug
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: Reproduction steps
description: Steps to reproduce the behavior
value: |
1.
2.
3.
...
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature Request
description: Use this template when creating a feature request.
labels:
- enhancement

body:
- type: textarea
id: describe-problem
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
validations:
required: true

- type: textarea
id: describe-solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: describe-alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Pull Request
description: Use this template when creating a pull request.

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to create this pull request.
Please note that as per our contribution guidelines, unless the pull
request is for a simple typo correction or obvious bug fix, it's
recommended to initiate a discussion by first raising an issue. This
enables us to assess proposed modifications and ascertain whether they
necessitate adjustments to the core platform or if there's a more
effective approach to achieve the desired outcome without making
modifications.
- type: textarea
id: related-issues
attributes:
label: Related issue(s) for this pull request
description: Link(s) to the issues this pull request is addressing.
validations:
required: true

- type: textarea
id: change-summary
attributes:
label: Summary of the changes being made by this pull request
description: An overview of the changes you've made and why they are necessary.
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots related to the changes here.
validations:
required: false
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

We welcome contributions from the community and first want to thank you for taking the time to contribute!

Please be aware that the design of the Educates platform allows for accomplishing many tasks without directly altering the core platform. Therefore, the guiding principle for this project is "discuss before code." If your intention is to contribute a pull request that goes beyond simple typo corrections or evident bug fixes, it's recommended to initiate a discussion by raising an issue. This preliminary step enables us to assess proposed modifications and ascertain whether they necessitate adjustments to the core platform or if there's a more effective approach to achieve the desired outcome without modifying it.
Please be aware that the design of the Educates platform allows for accomplishing many tasks without directly altering the core platform. Therefore, the guiding principle for this project is "discuss before code." If your intention is to contribute a pull request that goes beyond a simple typo correction or obvious bug fix, it's recommended to initiate a discussion by first raising an issue. This enables us to assess proposed modifications and ascertain whether they necessitate adjustments to the core platform or if there's a more effective approach to achieve the desired outcome without making modifications.

Even for seemingly minor alterations, we acknowledge that it might be more efficient for us to implement the changes. Feel free to articulate your objectives through an issue without any hesitation, and there's no pressure to create a pull request for the alteration. Our primary goal is to see you leverage Educates without unnecessary delays caused by configuration concerns.

Expand Down

0 comments on commit 1670019

Please sign in to comment.