diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1de226b3..1ee43850e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,15 +3,31 @@ We're always looking for people to help make Prowlarr 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://wikijs.servarr.com/Prowlarr) 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 12.X.X or higher) +- [Yarn](https://yarnpkg.com/) +- .NET Core 5.0. + +### Getting started ### + +1. Fork Prowlarr +2. Clone the repository into your development machine. [*info*](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github) +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 `Prowlarr.Console` and framework to `net5.0` +6. Debug the project in Visual Studio +7. Open http://localhost:7878 ### Contributing Code ### - If you're adding a new, already requested feature, please comment on [Github Issues](https://github.com/Prowlarr/Prowlarr/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 Prowlarr's develop branch, don't merge +- Rebase from Radarr'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 discord if you have any questions @@ -20,6 +36,10 @@ See the readme for information on setting up your development environment. - 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 2019 and WebStorm (to my knowledge) +### Contributing Indexers ### +- If you're contributing an indexer please phrase your commit as something like: `New: (Indexer) {Indexer Name}`, `New: (Indexer) {Usenet|Torrent} {Indexer Name}`, `New: (Indexer) {Torznab|Newznab} {Indexer Name}` +- If you're updating an indexer please phrase your commit as something like: `Fixed: (Indexer) {Indexer Name} {changes}` e.g. `Fixed: (Indexer) Changed BHD to use API` + ### 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 - You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability