Skip to content

Commit

Permalink
Add issue and pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
doonv committed Dec 29, 2023
1 parent 312c28f commit b663a8f
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Bug Report
about: Report a bug to help us improve!
title: ''
labels: bug, needs labels
assignees: ''
---

## bevy_dev_console version

The release number or commit hash of the version you're using.

## \[Optional\] Relevant system information

If you cannot get `bevy_dev_console` to build or run on your machine, please include:

- the Rust version you're using (you can get this by running `cargo --version`)
- Bevy (and by extension `bevy_dev_console`) relies on the "latest stable release" of Rust
- nightly should generally work, but there are sometimes regressions: please let us know!
- the operating system or browser used, including its version
- e.g. Windows 10, Ubuntu 18.04, iOS 14

## What you did

Describe how you arrived at the problem. If you can, consider providing a code snippet or link.

## What went wrong

If it's not clear, break this out into:

- what were you expecting?
- what actually happened?

## Additional information

Other information that can be used to further reproduce or isolate the problem.
This commonly includes:

- screenshots
- logs
- theories about what might be going wrong
- workarounds that you used
- links to related bugs, PRs or discussions
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature Request
about: Propose a new feature!
title: ''
labels: enchancements, needs labels
assignees: ''
---

## What problem does this solve or what need does it fill?

A description of why this particular feature should be added.

## What solution would you like?

The solution you propose for the problem presented.

## What alternative(s) have you considered?

Other solutions to solve and/or work around the problem presented.

## Additional context

Any other information you would like to add such as related previous work,
screenshots, benchmarks, etc.
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Objective

- Describe the objective or issue this PR addresses.
- If you're fixing a specific issue, say "Fixes #X".

## Solution

- Describe the solution used to achieve the objective above.

---

## Changelog

> This section is optional. If this was a trivial fix, or has no externally-visible impact, you can delete this section.
- What changed as a result of this PR?
- If applicable, organize changes under "Added", "Changed", or "Fixed" sub-headings
- Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section
- If you can't summarize the work, your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge!

0 comments on commit b663a8f

Please sign in to comment.