mirror of
https://github.com/Radarr/Radarr
synced 2024-12-23 00:12:44 +00:00
Update CONTRIBUTING.md
This commit is contained in:
parent
a4a1e4d5bf
commit
17ba245f77
1 changed files with 5 additions and 4 deletions
|
@ -18,22 +18,23 @@ Setup guides, FAQ, the more information we have on the wiki the better.
|
||||||
1. Fork NzbDrone
|
1. Fork NzbDrone
|
||||||
2. Clone (develop branch)
|
2. Clone (develop branch)
|
||||||
3. Run `npm install`
|
3. Run `npm install`
|
||||||
4. Run `grunt` - Used to compile the UI components and copy them (leave this window open)
|
4. Run `gulp watch` - Used to compile the UI components and copy them (leave this window open)
|
||||||
5. Compile in Visual Studio
|
5. Compile in Visual Studio
|
||||||
|
|
||||||
### Contributing Code ###
|
### Contributing Code ###
|
||||||
- If you're adding a new, already requested feature, please move it to In Progress on [Trello](http://trello.nzbdrone.com "Trello") so work is not duplicated.
|
- If you're adding a new, already requested feature, please comment on [Trello](http://trello.nzbdrone.com "Trello") so work is not duplicated (If you want to add something not already on there, please talk to us first)
|
||||||
- Rebase from NzbDrone's develop branch, don't merge
|
- Rebase from NzbDrone'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 forums or on IRC 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)
|
||||||
- Try to stick to one feature per 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 2012 and WebStorm (to my knowledge)
|
||||||
|
|
||||||
### Pull Requesting ###
|
### Pull Requesting ###
|
||||||
- You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability
|
- 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
|
- 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 comes from its own [feature branch](http://martinfowler.com/bliki/FeatureBranch.html) not develop in your fork
|
||||||
|
|
||||||
If you have any questions about any of this, please let us know.
|
If you have any questions about any of this, please let us know.
|
||||||
|
|
Loading…
Reference in a new issue