From f72a56f88a17ffa077884ccd116760f3180c3035 Mon Sep 17 00:00:00 2001 From: bakerboy448 <55419169+bakerboy448@users.noreply.github.com> Date: Tue, 24 Nov 2020 19:36:07 -0600 Subject: [PATCH] use lidarr's contributing as a new template for radarr [skip ci] -needs review --- CONTRIBUTING.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0001a48c..57c5c46f2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,11 +3,27 @@ We're always looking for people to help make Radarr even better, there are a number of ways to contribute. ## Documentation ## -Setup guides, FAQ, the more information we have on the wiki the better. +Setup guides, FAQ, the more information we have on the [wiki](https://wiki.servarr.com/Radarr) the better. ## Development ## -See the readme for information on setting up your development environment. +### Tools required ### +- Visual Studio 2019 or higher (https://www.visualstudio.com/vs/). The community version is free and works (https://www.visualstudio.com/downloads/). +- HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc) +- [Git](https://git-scm.com/downloads) +- [NodeJS](https://nodejs.org/en/download/) (Node 10.X.X or higher) +- [Yarn](https://yarnpkg.com/) +- .NET Core 3.1. + +### Getting started ### + +1. Fork Radarr +2. Clone the repository into your development machine. [*info*](https://help.github.com/articles/working-with-repositories) +3. Install the required Node Packages `yarn install` +4. Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command. +5. Build the project in Visual Studio, Setting startup project to `Radarr.Console` and framework to `netcoreapp31` +6. Debug the project in Visual Studio +7. Open http://localhost:8686 ### Contributing Code ### - If you're adding a new, already requested feature, please comment on [Github Issues](https://github.com/Radarr/Radarr/issues "Github Issues") so work is not duplicated (If you want to add something not already on there, please talk to us first) @@ -18,7 +34,7 @@ See the readme for information on setting up your development environment. - Add tests (unit/integration) - Commit with *nix line endings for consistency (We checkout Windows and commit *nix) - One feature/bug fix per pull request to keep things clean and easy to understand -- Use 4 spaces instead of tabs, this is the default for VS 2012 and WebStorm (to my knowledge) +- Use 4 spaces instead of tabs, this is the default for VS 2019 and WebStorm (to my knowledge) ### Pull Requesting ### - Only make pull requests to develop, never master, if you make a PR to master we'll comment on it and close it