Skip to content

Commit

Permalink
Added Github templates for issues and pull requests
Browse files Browse the repository at this point in the history
  • Loading branch information
antonpup committed Feb 1, 2017
1 parent be927f3 commit e6a7683
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## How to contribute!
#### I have found a bug!
- Please make sure that your bug was not already reported by searching the [Issues](https://github.com/antonpup/Aurora/issues).
- If your bug was already reported, please comment on the existing issue instead of making a new one.
- If your bug is new, feel free to make a [New Issue](https://github.com/antonpup/Aurora/issues/new).

#### I want to contribute code!
- You can fork this repo and make changes to the code on the [dev branch](https://github.com/antonpup/Aurora/tree/dev).
- The [dev branch](https://github.com/antonpup/Aurora/tree/dev) is the usually the most up-to-date branch on the repo.
- Please ensure that your new code follows the [CamelCase](https://en.wikipedia.org/wiki/Camel_case) naming convention.
- If you want to make a pull request, please make sure that you are making a pull request into the dev branch (and not master).

We appreciate your kind efforts in making Aurora a better software!
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!-- Thank you for reporting issues to us! Please try to answer all the questions below. If you don't have an issue to report, you can delete the pre-filled contents and proceed with your comments. -->

### What are you experiencing an issue with?
<!-- These [ ] are checkboxes, they can be checked like so [x] -->
- [ ] Aurora
- [ ] Aurora supported game, (Fill in the game)
- [ ] Aurora Wrapper
- [ ] Aurora Profile
- [ ] Aurora supported device, (Fill in problematic devices)
- [ ] Aurora Scripts
- [ ] Aurora Updater
- [ ] Aurora Lighting issue
- [ ] Other, (Fill in another issue here)

### What kind of an issue is it?
<!-- These [ ] are checkboxes, they can be checked like so [x] -->
- [ ] Crash
- [ ] Performance problems
- [ ] Visual bug
- [ ] Localization issue
- [ ] Enhancement suggestion
- [ ] Device issue
- [ ] Other, (Fill in another type of issue here)

### Expected behavior:
Explain here what should happen.

### Actual behavior:
Explain here what happened instead.

### How often does this problem occur?
<!-- Every time, sometimes, happened once, not sure -->
This problem occurs... (Fill in here)

### Please describe the steps to reproduce this issue:
The issue can be reproduced by doing following steps:

1.
2.
3.

### What is the version of Aurora you are experiencing this issue with?
<!-- Aurora version can be located in settings under the About tab -->
My version is... (Fill in here)

### Does the previous version of Aurora have this issue?
The previous version, (Fill in the version here), did/did not have this issue.

### Please include any logs, screenshots, or files that are related to this issue:
<!-- Log files can be located in the "Aurora Location/logs" directory. -->
For logs, you can use: http://pastebin.com/
For screenshots, you can use: http://imgur.com/
For files, you can use: http://www.tinyupload.com/ , https://www.dropbox.com/ , or attach them to the issue.
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!-- Thank you for helping Aurora grow as a community project! We appreciate your help, and would love to see more additions to our code from you! :) -->

<!--
============================
A checklist before submitting a Pull Request
============================
1. Ensure that your code follows the CamelCase naming convention. ( https://en.wikipedia.org/wiki/Camel_case )
2. Ensure that you are making a pull request for the dev branch, and not master branch. ( Master branch commits will not be accepted )
3. Fill out the form below with as much information as you can. Feel free to add more comments if you need to.
-->

**List any issues that this PR fixes:** fixes # , etc...
<!-- For example, "Fixes #287 , fixes #100 , and fixes #20" -->

**This pull request proposes the following changes:**
<!-- List changes that this RP includes -->
-
-
-

**Known issues/To do:**
<!-- List any bugs that are introduced with this PR or anything that needs further development -->
-
-
-

0 comments on commit e6a7683

Please sign in to comment.