2014-01-27 22:10:37 +00:00
# How to Contribute #
2016-03-02 18:03:37 +00:00
We're always looking for people to help make Sonarr even better, there are a number of ways to contribute.
2014-01-27 22:10:37 +00:00
## Documentation ##
2021-01-14 01:00:09 +00:00
Setup guides, [FAQ ](https://wiki.servarr.com/Sonarr_FAQ ), the more information we have on the [wiki ](https://wiki.servarr.com/Sonarr ) the better.
2014-01-27 22:10:37 +00:00
## Development ##
2021-01-14 01:00:09 +00:00
### 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/ )
### Getting started ###
1. Fork Sonarr
2021-02-27 20:16:38 +00:00
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 )
2021-01-14 01:00:09 +00:00
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 `Sonarr.Console` and framework to `x86`
6. Debug the project in Visual Studio
7. Open http://localhost:8989
2014-01-27 22:10:37 +00:00
### Contributing Code ###
2015-07-08 21:23:12 +00:00
- If you're adding a new, already requested feature, please comment on [Github Issues ](https://github.com/Sonarr/Sonarr/issues "Github Issues" ) so work is not duplicated (If you want to add something not already on there, please talk to us first)
2021-01-14 01:00:09 +00:00
- Rebase from Sonarr's develop (currently phantom-develop) branch, don't merge
2014-01-27 22:10:37 +00:00
- 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
2021-01-14 01:00:09 +00:00
- Reach out to us on our [forums ](https://forums.sonarr.tv/ ), [subreddit ](https://www.reddit.com/r/sonarr/ ), [discord ](https://discord.gg/Ex7FmFK ), or [IRC ](http://webchat.freenode.net/?channels=#sonarr ) if you have any questions
2014-01-27 22:10:37 +00:00
- Add tests (unit/integration)
- Commit with *nix line endings for consistency (We checkout Windows and commit *nix)
2014-11-03 16:21:19 +00:00
- One feature/bug fix per pull request to keep things clean and easy to understand
2021-01-14 01:00:09 +00:00
- Use 4 spaces instead of tabs, this should be the default for VS 2019 and WebStorm
2014-01-27 22:10:37 +00:00
### Pull Requesting ###
2021-01-14 01:00:09 +00:00
- Only make pull requests to develop (currently phantom-develop), never master, if you make a PR to master we'll comment on it and close it
2014-01-27 22:10:37 +00:00
- You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability
- We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it
2015-02-21 05:14:18 +00:00
- Each PR should come from its own [feature branch ](http://martinfowler.com/bliki/FeatureBranch.html ) not develop in your fork, it should have a meaningful branch name (what is being added/fixed)
- new-feature (Good)
- fix-bug (Good)
- patch (Bad)
- develop (Bad)
2014-01-27 22:10:37 +00:00
2014-11-03 16:21:19 +00:00
If you have any questions about any of this, please let us know.
