Skip to content

Commit

Permalink
Add CONTRIBUTING AND ISSUE_TEMPLATE
Browse files Browse the repository at this point in the history
[ci skip]

Signed-off-by: Alex Coles <alex@alexbcoles.com>
  • Loading branch information
myabc committed Dec 14, 2016
1 parent dd02760 commit b6f28e2
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,31 @@
## How to contribute to Roar

#### **Did you find a bug?**

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/trailblazer/roar/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/trailblazer/roar/issues/new). Be sure to follow the issue template.

#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

* All code in pull requests is assumed to be MIT licensed. Do not submit a pull request if that isn't the case.

#### **Do you intend to add a new feature or change an existing one?**

* Suggest your change in the [Trailblazer Gitter Room](https://gitter.im/trailblazer/chat) and start writing code.

* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

#### **Do you have questions using Roar?**

* Ask any questions about how to use Roar in the [Trailblazer Gitter Room](https://gitter.im/trailblazer/chat). Github issues are restricted to bug reports and fixes.

* GitHub Issues should not be used as a help forum and any such issues will be closed.

#### **Do you want to contribute to the Roar documentation?**

* Roar documentation is provided via the [Trailblazer site](http://trailblazer.to/gems/roar/) and not the repository readme. Please add your contributions to the [Trailblazer site repository](https://github.com/trailblazer/trailblazer.github.io)
20 changes: 20 additions & 0 deletions ISSUE_TEMPLATE.md
@@ -0,0 +1,20 @@
Note: If you have a question about Roar, would like help using
Roar, want to request a feature, or do anything else other than
submit a bug report, please use the Trailblazer gitter channel.

### Complete Description of Issue


### Steps to reproduce


### Expected behavior
Tell us what should happen

### Actual behavior
Tell us what happens instead

### System configuration
**Roar version**:

### Full Backtrace of Exception (if any)

0 comments on commit b6f28e2

Please sign in to comment.