Skip to content
Permalink
Browse files

🚸(github) add templates for github issues and PRs

We add these templates in a `.github` folder in
order not to clutter the project root directory.
We offer several separate issue templates in an
attempt to separate bugs, features and questions
and get the best information possible from the issue
creator.
  • Loading branch information...
sampaccoud committed Jun 5, 2018
1 parent 06771c4 commit a412e2cf5af50d5efff8774d733b9a9320b6adb9
@@ -0,0 +1,6 @@
<!---
Thanks for filing an issue πŸ˜„ ! Before you submit, please read the following:
Check the other issue templates if you are trying to submit a bug report, feature request, or question
Search open/closed issues before submitting since someone might have asked the same thing before!
-->
@@ -0,0 +1,28 @@
---
name: πŸ› Bug Report
about: If something is not working as expected πŸ€”.

---

## Bug Report

**Expected behavior/code**
A clear and concise description of what you expected to happen (or code).

**Actual Behavior**
A clear and concise description of the behavior.

**Steps to Reproduce**
1. Do this...
2. Then this...
3. And then the bug happens!

**Environment**
- Arnold version:
- Platform:

**Possible Solution**
<!--- Only if you have suggestions on a fix for the bug -->

**Additional context/Screenshots**
Add any other context about the problem here. If applicable, add screenshots to help explain.
@@ -0,0 +1,23 @@
---
name: ✨ Feature Request
about: I have a suggestion (and may want to build it πŸ’ͺ)!

---

## Feature Request

**Is your feature request related to a problem or unsupported use case? Please describe.**
A clear and concise description of what the problem is. For example: I need to do some task and I have an issue...

**Describe the solution you'd like**
A clear and concise description of what you want to happen. Add any considered drawbacks.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Discovery, Documentation, Adoption, Migration Strategy**
If you can, explain how users will be able to use this and possibly write out a version the docs (if applicable).
Maybe a screenshot or design?

**Do you want to work on it through a Pull Request?**
<!-- Make sure to coordinate with us before you spend too much time working on an implementation! -->
@@ -0,0 +1,22 @@
---
name: πŸ€— Support Question
about: If you have a question πŸ’¬, or something was not clear from the docs!

---

<!-- ^ Click "Preview" for a nicer view! ^
We primarily use GitHub as an issue tracker. If however you're encountering an issue not covered in the docs, we may be able to help! -->

---

Please make sure you have read our [main Readme](https://github.com/openfun/arnold) as well as our [documentation folder](https://github.com/openfun/arnold/tree/master/docs).

Also make sure it was not already answered in [an open or close issue](https://github.com/openfun/arnold/issues).

If your question was not covered, and you feel like it should be, fire away! We'd love to improve our docs! πŸ‘Œ

**Topic**
What's the general area of your question: for example, configuration, deployment strategy, interoperability...

**Question**
Try to be as specific as possible so we can help you as best we can. Please be patient πŸ™
@@ -0,0 +1,11 @@
## Purpose

Description...


## Proposal

Description...

- [] item 1...
- [] item 2...

0 comments on commit a412e2c

Please sign in to comment.
You can’t perform that action at this time.