2014-01-27 22:10:37 +00:00
# How to Contribute #
2017-05-06 14:44:46 +00:00
We're always looking for people to help make Lidarr even better, there are a number of ways to contribute.
2014-01-27 22:10:37 +00:00
2021-07-29 19:44:51 +00:00
This file is updated on an ad-hoc basis, for the latest details please see the [contributing wiki page ](https://wiki.servarr.com/lidarr/contributing ).
2014-01-27 22:10:37 +00:00
## Documentation ##
2021-07-29 19:44:51 +00:00
Setup guides, FAQ, the more information we have on the [wiki ](https://wiki.servarr.com/lidarr ) the better.
2014-01-27 22:10:37 +00:00
## Development ##
### Tools required ###
2020-11-25 01:20:03 +00:00
- Visual Studio 2019 or higher (https://www.visualstudio.com/vs/). The community version is free and works fine. [Download it here ](https://www.visualstudio.com/downloads/ ).
2018-04-01 17:35:55 +00:00
- HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc)
2019-04-14 03:19:37 +00:00
- [Git ](https://git-scm.com/downloads )
2020-09-07 01:47:08 +00:00
- [NodeJS ](https://nodejs.org/en/download/ ) (Node 10.X.X or higher)
2019-04-14 03:19:37 +00:00
- [Yarn ](https://yarnpkg.com/ )
2020-09-07 01:47:08 +00:00
- .NET Core 3.1.
2014-01-27 22:10:37 +00:00
### Getting started ###
2019-04-14 03:19:37 +00:00
1. Fork Lidarr
2021-04-02 03:05:09 +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 )
2020-11-25 01:20:03 +00:00
3. Install the required Node Packages `yarn install`
2021-06-27 04:05:34 +00:00
4. Start webpack to monitor your dev environment for any changes that need post processing using `yarn start` command.
2020-11-25 01:20:03 +00:00
5. Build the project in Visual Studio, Setting startup project to `Lidarr.Console` and framework to `netcoreapp31`
6. Debug the project in Visual Studio
7. Open http://localhost:8686
Be sure to run lint `yarn lint --fix` on your code for any front end changes before comitting.
For css changes `yarn stylelint-windows --fix`
2014-01-27 22:10:37 +00:00
### Contributing Code ###
2017-05-06 14:44:46 +00:00
- 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
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
2019-04-14 03:19:37 +00:00
- Reach out to us on the discord 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
2020-09-07 01:47:08 +00:00
- Use 4 spaces instead of tabs, this is the default for VS 2019 and WebStorm (to my knowledge)
2014-01-27 22:10:37 +00:00
### Pull Requesting ###
2015-02-21 05:14:18 +00:00
- Only make pull requests to 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.
