Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

merge master changes into dev #2044

Merged
merged 13 commits into from
May 26, 2020
33 changes: 22 additions & 11 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
## 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).
# Contributing to Aurora

#### 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).
### 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 and you have additional information to provide, please comment on the existing issue. Do not create a new issue that is a duplicate of an existing one (unless it has been closed).
- If you cannot find your issue reported, please make a [New Issue](https://github.com/antonpup/Aurora/issues/new) and follow the bug report template.

We appreciate your kind efforts in making Aurora a better software!
### I want to contribute code!
- Please first create your own fork of this repo if you do not already have one.
- If you have not done so yet, you will need to clone your repo onto your local machine for development. `git clone https://github.com/your-username/Aurora.git`
- You will also need to add the main repo as an upstream to get updated commits. `git remote add upstream https://github.com/antonpup/Aurora.git`
- Make sure your fork is up-to-date with the latest dev branch on the main repo. `git fetch upstream`
- Create a feature or fix branch from the latest dev branch. `git checkout -b feature/my-new-feature upstream/dev`
- If you plan on adding new features, please prefix your branch name with 'feature/'. For example `feature/audio-layer-improvements`.
- If you plan on fixing bugs, please prefix your branch name with 'fix/'. For example `fix/layer-selection`.
- If you are adding features and bug fixes, use 'feature/'.
- If you are adding or fixing multiple unrelated areas, please divide your code into different branches. For example, don't add a new device at the same time as you change how the overrides system works.
- Please ensure that your code follows the existing conventions set out in the code (such as using auto properties where applicable, naming conventions, etc.).
- When you have finished your feature or bug fix, push your changes to your remote branch. E.g. `git push origin feature/my-cool-feature`
- Create a [new pull request](https://github.com/antonpup/Aurora/compare) on the main Aurora repo.
- Add a descriptive title and description which includes a detailed list of what has been changed and any known issues. You may also wish to include screenshots, examples and important design decisions you made in the description too.
- A collaborator will review your PR and accept it or make suggestions on what should be changed.

We appreciate your kind efforts in making Aurora a better software! :tada:
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Bug Report
about: Report an issue with how the program works.
labels: bug
labels: 'Type: Bug'
---
<!--
Thank you for reporting your issues to us, helping to make Aurora better! :)
Expand Down
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: Discord
url: https://discord.gg/YAuBmg9
about: Please direct any questions to our Discord server. You may also ask about any issue here - you may receive a faster response on Discord than GitHub.

4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/device_request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Device Request
about: Request support for a new hardware device.
labels: hardware support
labels: 'Type: Enhancement,Area: Hardware Support'
---
<!--
Please make sure you SEARCH for any other issues requesting your device before submitting your issue - it might already have been requested.
Expand All @@ -21,4 +21,4 @@ Please add support for the following device:

**Device Name:** <!-- Make/model of device -->

**Device Website:** <!-- Please add a link to the manufacturer's website -->
**Device Website:** <!-- Please add a link to the manufacturer's website -->
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: Enhancement
about: Got an idea for a new feature for Aurora? Put it here.
labels: enhancement
labels: 'Type: Enhancement'
---
<!--
Thank you for helping to improve the Aurora lighting software.

Please describe your suggested idea in-depth below. What will it do? How will it work?
-->
-->
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/game_request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Game Request
about: Request support for a new game or application.
labels: game support
labels: 'Type: Enhancement,Area: Game Support'
---
<!--
Please make sure you SEARCH for any other issues requesting this game before submitting your issue - it might already have been requested.
Expand All @@ -28,4 +28,4 @@ Please add support for the following game:

**Game Name:** <!-- What game is it? -->

**Methods:** <!-- Please tell us which methods of getting data this game has (see above). Native GSI/Mod support/Memory reading -->
**Methods:** <!-- Please tell us which methods of getting data this game has (see above). Native GSI/Mod support/Memory reading -->
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center"><a href="https://github.com/simon-wh"><img src="https://avatars3.githubusercontent.com/u/10797576?v=4" width="100px;" alt=""/><br /><sub><b>Simon W</b></sub></a><br /><a href="https://github.com/antonpup/Aurora/commits?author=simon-wh" title="Code">💻</a> <a href="#question-simon-wh" title="Answering Questions">💬</a> <a href="https://github.com/antonpup/Aurora/commits?author=simon-wh" title="Documentation">📖</a> <a href="#infra-simon-wh" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/antonpup/Aurora/pulls?q=is%3Apr+reviewed-by%3Asimon-wh" title="Reviewed Pull Requests">👀</a> <a href="#projectManagement-simon-wh" title="Project Management">📆</a> <a href="#maintenance-simon-wh" title="Maintenance">🚧</a></td>
<td align="center"><a href="https://github.com/Wibble199"><img src="https://avatars0.githubusercontent.com/u/3984322?v=4" width="100px;" alt=""/><br /><sub><b>Will Bennion</b></sub></a><br /><a href="https://github.com/antonpup/Aurora/commits?author=Wibble199" title="Code">💻</a> <a href="#question-Wibble199" title="Answering Questions">💬</a> <a href="https://github.com/antonpup/Aurora/commits?author=Wibble199" title="Documentation">📖</a> <a href="#maintenance-Wibble199" title="Maintenance">🚧</a> <a href="https://github.com/antonpup/Aurora/pulls?q=is%3Apr+reviewed-by%3AWibble199" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/diogotr7"><img src="https://avatars2.githubusercontent.com/u/29486064?v=4" width="100px;" alt=""/><br /><sub><b>Diogo Trindade</b></sub></a><br /><a href="https://github.com/antonpup/Aurora/commits?author=diogotr7" title="Code">💻</a> <a href="#question-diogotr7" title="Answering Questions">💬</a> <a href="#maintenance-diogotr7" title="Maintenance">🚧</a> <a href="#projectManagement-diogotr7" title="Project Management">📆</a> <a href="https://github.com/antonpup/Aurora/pulls?q=is%3Apr+reviewed-by%3Adiogotr7" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/antonpup/Aurora/commits?author=diogotr7" title="Documentation">📖</a></td>
<td align="center"><a href="https://www.uniquegem.net"><img src="https://avatars1.githubusercontent.com/u/20298837?v=4" width="100px;" alt=""/><br /><sub><b>Gurjot</b></sub></a><br /><a href="https://github.com/antonpup/Aurora/commits?author=Gurjot95" title="Code">💻</a> <a href="#question-Gurjot95" title="Answering Questions">💬</a> <a href="#maintenance-Gurjot95" title="Maintenance">🚧</a></td>
<td align="center"><a href="https://github.com/Gurjot95"><img src="https://avatars1.githubusercontent.com/u/20298837?v=4" width="100px;" alt=""/><br /><sub><b>Gurjot</b></sub></a><br /><a href="https://github.com/antonpup/Aurora/commits?author=Gurjot95" title="Code">💻</a> <a href="#question-Gurjot95" title="Answering Questions">💬</a> <a href="#maintenance-Gurjot95" title="Maintenance">🚧</a></td>
<td align="center"><a href="https://github.com/gitmacer"><img src="https://avatars3.githubusercontent.com/u/37345589?v=4" width="100px;" alt=""/><br /><sub><b>Tim Oberle</b></sub></a><br /><a href="https://github.com/antonpup/Aurora/commits?author=gitmacer" title="Code">💻</a> <a href="#question-gitmacer" title="Answering Questions">💬</a> <a href="https://github.com/antonpup/Aurora/issues?q=author%3Agitmacer" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/SnakePin"><img src="https://avatars1.githubusercontent.com/u/18491360?v=4" width="100px;" alt=""/><br /><sub><b>SnakePin</b></sub></a><br /><a href="https://github.com/antonpup/Aurora/commits?author=SnakePin" title="Code">💻</a> <a href="#question-SnakePin" title="Answering Questions">💬</a></td>
</tr>
Expand Down Expand Up @@ -99,7 +99,7 @@ If you're a developer or just a software user you can help the project by:

* [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json) - Used for JSON parsing
* [Colore](https://github.com/CoraleStudios/Colore) - Used for Razer suppport
* [CUE.NET](https://github.com/DarthAffe/CUE.NET) - Used for Corsair support
* [RGB.NET](https://github.com/DarthAffe/RGB.NET) - Used for Corsair support
* [Xceed.Wpf.Toolkit](http://wpftoolkit.codeplex.com/) - Used for Color Picker and Integer Up Down controls
* [MouseKeyHook](https://github.com/gmamaladze/globalmousekeyhook) - Used or interactive effects
* [NAudio](https://github.com/naudio/NAudio) - Used for Volume Control
Expand All @@ -112,4 +112,4 @@ If you're a developer or just a software user you can help the project by:
* [ColorBox](http://colorbox.codeplex.com/) - Used for gradient editor/picker. This repo contains a modified version of ColorBox, to suit Aurora's needs a bit more.
* [SharpDX](http://sharpdx.org/) - Used for Raw Input for nonblocking input reading for key binds and interactive effects
* [HidLibrary](https://github.com/mikeobrien/HidLibrary) - Used for communication with HID devices
* [NZXTSharp](https://github.com/akmadian/NZXTSharp) - NZXT SDK, Used for NZXT support
* [NZXTSharp](https://github.com/akmadian/NZXTSharp) - NZXT SDK, Used for NZXT support