From 3739c90dd39aaf9113fa2eba849679f775a29929 Mon Sep 17 00:00:00 2001 From: Qstick Date: Sat, 13 Apr 2019 23:19:37 -0400 Subject: [PATCH] Fixed: Update Contributing.md Instructions --- CONTRIBUTING.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05e435d98..47b8f3097 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,31 +8,34 @@ Setup guides, FAQ, the more information we have on the wiki the better. ## Development ## ### Tools required ### -- Visual Studio 2017 +- Visual Studio 2017 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) -- yarn (package manager) -- git +- [Git](https://git-scm.com/downloads) +- [NodeJS](https://nodejs.org/en/download/) (Node 8.X.X or higher) +- [Yarn](https://yarnpkg.com/) +- .NET 4.6.1 or Mono equivalent. ### Getting started ### -1. Fork Lidarr -2. Clone (develop branch) *you may need pull in submodules separately if you client doesn't clone them automatically (CurlSharp)* -3. Run `yarn install` -4. Run `yarn start` - Used to compile the UI components and copy them. - Leave this window open. - If you have gulp globally installed you can use `gulp watch` instead -5. Compile in Visual Studio +1. Fork Lidarr +2. Clone the repository into your development machine. [*info*](https://help.github.com/articles/working-with-repositories) +3. Grab the submodules `git submodule init && git submodule update` +4. Install the required Node Packages `yarn install` +5. Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command. +6. Build the project in Visual Studio, Setting startup project to `NZBDrone.Console` +7. Debug the project in Visual Studio +8. Open http://localhost:8686 ### Contributing Code ### - If you're adding a new, already requested feature, please comment on [Github Issues](https://github.com/lidarr/Lidarr/issues "Github Issues") so work is not duplicated (If you want to add something not already on there, please talk to us first) - Rebase from Lidarr's develop branch, don't merge - Make meaningful commits, or squash them - Feel free to make a pull request before work is complete, this will let us see where its at and make comments/suggest improvements -- Reach out to us on the forums or on IRC if you have any questions +- Reach out to us on the discord if you have any questions - 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 2017 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