mirror of
https://github.com/lidarr/Lidarr
synced 2024-12-24 16:51:58 +00:00
52 lines
2.9 KiB
Markdown
52 lines
2.9 KiB
Markdown
# How to Contribute #
|
|
|
|
We're always looking for people to help make Lidarr even better, there are a number of ways to contribute.
|
|
|
|
## Documentation ##
|
|
Setup guides, FAQ, the more information we have on the [wiki](https://wiki.servarr.com/Lidarr) the better.
|
|
|
|
## Development ##
|
|
|
|
### Tools required ###
|
|
- 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/).
|
|
- 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/)
|
|
- .NET Core 3.1.
|
|
|
|
### Getting started ###
|
|
|
|
1. Fork Lidarr
|
|
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 `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`
|
|
|
|
### 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 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 2019 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
|
|
- 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
|
|
- 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)
|
|
|
|
If you have any questions about any of this, please let us know.
|