-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add templates for bug reports and feature requests (#155)
* Add bug report template * Add feature request template * Update CONTRIBUTING
- Loading branch information
Showing
3 changed files
with
60 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
name: Bug report | ||
about: Create a bug report to help us improve | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
--- | ||
|
||
**Description** | ||
A clear and concise description of what the bug is. | ||
|
||
**Steps to reproduce** | ||
Steps to reproduce the behavior. | ||
|
||
```rust | ||
// Add relevant code-snippets here... | ||
|
||
|
||
|
||
``` | ||
|
||
**Expected result** | ||
The expected result. | ||
|
||
**Actual result** | ||
The actual result. | ||
|
||
|
||
**Additional information** | ||
This is not required, but can be very helpful when trying to find the root cause. It may include other things as well, not only the things listed below. | ||
|
||
- Orion features selected: `default-features = false`, default, `alloc`, etc | ||
- Orion version: `v0.10.0`, `master`, etc | ||
- Rust version: `$ rustc -V` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest a new idea for the project | ||
labels: new feature | ||
--- | ||
|
||
**Summary** | ||
Brief explanation of the feature. | ||
|
||
**Basic example** | ||
If the proposal involves a new or changed API, include a basic code example. Omit this section if it's not applicable. | ||
|
||
```rust | ||
// Add relevant code-snippets here... | ||
|
||
|
||
``` | ||
|
||
**Motivation** | ||
Why are we doing this? What use cases does it support? Will it be used anywhere? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters