diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 17c9f46db..57a0d098b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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! \ No newline at end of file +### 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: diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7b65d927c..5374cdc09 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: Bug Report about: Report an issue with how the program works. -labels: bug +labels: 'Type: Bug' --- -**Device Website:** \ No newline at end of file +**Device Website:** diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md index 751c4dc0e..08871cef8 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -1,10 +1,10 @@ --- name: Enhancement about: Got an idea for a new feature for Aurora? Put it here. -labels: enhancement +labels: 'Type: Enhancement' --- \ No newline at end of file +--> diff --git a/.github/ISSUE_TEMPLATE/game_request.md b/.github/ISSUE_TEMPLATE/game_request.md index 49d8b9936..47780e088 100644 --- a/.github/ISSUE_TEMPLATE/game_request.md +++ b/.github/ISSUE_TEMPLATE/game_request.md @@ -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' --- -**Methods:** \ No newline at end of file +**Methods:** diff --git a/README.md b/README.md index 650efc812..e681d3c44 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
Simon W
💻 💬 📖 🚇 👀 📆 🚧
Will Bennion
💻 💬 📖 🚧 👀
Diogo Trindade
💻 💬 🚧 📆 👀 📖 -
Gurjot
💻 💬 🚧 +
Gurjot
💻 💬 🚧
Tim Oberle
💻 💬 🐛
SnakePin
💻 💬 @@ -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 @@ -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 \ No newline at end of file +* [NZXTSharp](https://github.com/akmadian/NZXTSharp) - NZXT SDK, Used for NZXT support