Skip to content

Commit

Permalink
Add Issue and PR templates (#73)
Browse files Browse the repository at this point in the history
* init bug / feat templates

* capital J for style

* PR templates

* Combine templates because github be like that
  • Loading branch information
EncodedVenom authored Jul 13, 2024
1 parent 45adef0 commit d76f343
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Bug report
about: File a bug report for any behavior that you believe is unintentional or problematic
title: "[BUG]"
labels: bug
assignees: ''

---

## Describe the bug
Put a clear and concise description of what the bug is. This should be short and to the point, not to exceed more than a paragraph. Put the details inside your reproduction steps.

## Reproduction
Make an easy-to-follow guide on how to reproduce it. Does it happen all the time? Will specific features affect reproduction? All these questions should be answered for a good issue.

This is a good place to put rbxl files or scripts that help explain your reproduction steps.

## Expected Behavior
What you expect to happen

## Actual Behavior
What actually happens
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature Request
about: File a feature request for something you believe should be added to Jecs
title: "[FEATURE]"
labels: feature
assignees: ''

---

## Describe your Feature

You should explain your feature here, and the motivation for why you want it.

## Implementation

Explain how you would implement your feature here. Provide relevant API examples and such here (if applicable).

## Alternatives

What other alternative implementations or otherwise relevant information is important to why you decided to go with this specific implementation?

## Considerations

Some questions that need to be answered include the following:
- Will old code break in response to this feature?
- What are the performance impacts with this feature (if any)?
- How is it useful to include?
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Brief Description of your Changes.

Describe what you did here. Additionally, you should link any relevant issues within this section. If there is no corresponding issue, you should include relevant information (repro steps, motivation, etc) here.

## Impact of your Changes

What implications will this have on the project? Will there be altered behavior or performance with this change?

## Tests Performed

What have you done to ensure this change has the least possible impact on the project?

## Additional Comments

Anything else you feel is relevant.

0 comments on commit d76f343

Please sign in to comment.