Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-07-09 03:14:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update contributing.md

Browse Source
This commit is contained in:
Hillel Coren 2017-03-19 17:22:06 +02:00
parent 1fb06295d4
commit 0f161eb2c9
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -4,6 +4,8 @@ Thanks for your contributions!
## Submit bug reports or feature requests ## Submit bug reports or feature requests
Please discuss the changes with us ahead of time to ensure they will be merged.
### Submit pull requests ### Submit pull requests
* [Fork](https://github.com/invoiceninja/invoiceninja#fork-destination-box) the [Invoice Ninja repository](https://github.com/invoiceninja/invoiceninja) * [Fork](https://github.com/invoiceninja/invoiceninja#fork-destination-box) the [Invoice Ninja repository](https://github.com/invoiceninja/invoiceninja)
* Create a new branch with the name `#issue_number-Short-description` * Create a new branch with the name `#issue_number-Short-description`
@ -11,7 +13,7 @@ Thanks for your contributions!
* Make your changes and commit * Make your changes and commit
* Check if your branch is still in sync with the repositorys **`develop`** branch * Check if your branch is still in sync with the repositorys **`develop`** branch
* _Read:_ [Syncing a fork](https://help.github.com/articles/syncing-a-fork/) * _Read:_ [Syncing a fork](https://help.github.com/articles/syncing-a-fork/)
* _Also read:_ [How to rebase a pull request](https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request) * _Also read:_ [How to rebase a pull request](https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request)
* Push your branch and create a PR against the Invoice Ninja **`develop`** branch * Push your branch and create a PR against the Invoice Ninja **`develop`** branch
* Update the [Changelog](CHANGELOG.md) * Update the [Changelog](CHANGELOG.md)
@ -21,7 +23,7 @@ To make the contribution process nice and easy for anyone, please follow some ru
to give a more detailed explanation. to give a more detailed explanation.
* Only one feature/bugfix per issue. If you want to submit more, create multiple issues. * Only one feature/bugfix per issue. If you want to submit more, create multiple issues.
* Only one feature/bugfix per PR(pull request). Split more changes into multiple PRs. * Only one feature/bugfix per PR(pull request). Split more changes into multiple PRs.
#### Coding Style #### Coding Style
Try to follow the [PSR-2 guidlines](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) Try to follow the [PSR-2 guidlines](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
@ -29,7 +31,7 @@ _Example styling:_
```php ```php
/** /**
* Gets a preview of the email * Gets a preview of the email
* *
* @param TemplateService $templateService * @param TemplateService $templateService
* *
* @return \Illuminate\Http\Response * @return \Illuminate\Http\Response