mirror/Lidarr
1
0
Fork 0
mirror of https://github.com/lidarr/Lidarr synced 2025-01-20 13:49:56 +00:00
Code Issues Releases Wiki Activity

Fixed: Update Contributing.md Instructions

Browse source
This commit is contained in:
Qstick 2019-04-13 23:19:37 -04:00 committed by GitHub
parent 43f297099e
commit 3739c90dd3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
CONTRIBUTING.md
View file

@ -8,31 +8,34 @@ Setup guides, FAQ, the more information we have on the wiki the better.
## Development ## ## Development ##
### Tools required ### ### 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) - HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc)
- yarn (package manager) - [Git](https://git-scm.com/downloads)
- git - [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 ### ### Getting started ###
1. Fork Lidarr 1. Fork Lidarr
2. Clone (develop branch) *you may need pull in submodules separately if you client doesn't clone them automatically (CurlSharp)* 2. Clone the repository into your development machine. [*info*](https://help.github.com/articles/working-with-repositories)
3. Run `yarn install` 3. Grab the submodules `git submodule init && git submodule update`
4. Run `yarn start` - Used to compile the UI components and copy them. 4. Install the required Node Packages `yarn install`
Leave this window open. 5. Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command.
If you have gulp globally installed you can use `gulp watch` instead 6. Build the project in Visual Studio, Setting startup project to `NZBDrone.Console`
5. Compile in Visual Studio 7. Debug the project in Visual Studio
8. Open http://localhost:8686
### Contributing Code ### ### 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) - 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 - Rebase from Lidarr's develop branch, don't merge
- Make meaningful commits, or squash them - 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 - 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) - Add tests (unit/integration)
- Commit with *nix line endings for consistency (We checkout Windows and commit *nix) - 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 - 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 ### ### 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 - Only make pull requests to develop, never master, if you make a PR to master we'll comment on it and close it