Skip to content

Commit

Permalink
Add templates for bug reports and feature requests (#155)
Browse files Browse the repository at this point in the history
* Add bug report template

* Add feature request template

* Update CONTRIBUTING
  • Loading branch information
brycx authored Dec 26, 2020
1 parent e4c19e9 commit 14584fa
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 22 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
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`
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
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?
28 changes: 6 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,29 +25,17 @@ Quality of documentation is a vital part of this project. Contributions to this

Try to make changes adhere to the [Rust API Guidelines](https://rust-lang-nursery.github.io/api-guidelines/checklist.html) as much as possible.

### 2. Bug Reports
A bug report should _ideally_ include all the information in this template:
### 2. Bug Reports and Feature Requests
There are templates for both these scenarios, please see the `.github/ISSUE_TEMPLATE/` directory.

```
Brief description:
Steps to reproduce:
Expected result:
Actual result:
Additional information:
- Rust version ($ rustc -V)
- orion version
```

Bug reports don't need to strictly follow this template but in most cases, more information about the bug makes it easier to analyze and fix.
A bug report or feature request should _ideally_ follow the provided templates. It's not a strict requirement but in most cases, more information about the bug or feature makes it easier to fix/evaluate.

### 3. Pull Requests

Before submitting a pull request, please make sure you have done the following:

- [ ] Explain what the pull request changes, in the description of the GitHub PR, or link to the relevant issue.

- [ ] A change or addition of functionality is covered by unit-tests.

- [ ] Ensure that all tests pass when running:
Expand All @@ -60,12 +48,8 @@ Before submitting a pull request, please make sure you have done the following:
- `cargo clippy`
- `cargo fmt`

- [ ] Explain what the pull request changes, in the description of the GitHub PR.
- [ ] If the pull request is a bugfix, try to include a regression test for the bug.

All pull requests should be opened against the `master` branch.

If your pull request is still work-in-progress, make the title of the pull request start with `[WIP]`.

### 4. Feature Requests
A request for a new feature should be started in a GitHub issue. This issue should explain what feature is requested, why it is requested and, if applicable, the use-case behind it.
If your pull request is still work-in-progress, make the title of the pull request start with `WIP:`.

0 comments on commit 14584fa

Please sign in to comment.