diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c271968668be..e888da72d3bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,44 @@ # Contributing to Invoice Ninja -We welcome contributions! We'll improve this guide over time... +Thanks for your contributions! -*Please note: although our application is open-source we run a for-profit hosted service at [invoiceninja.com](https://www.invoiceninja.com).* +## Submit bug reports or feature requests -Guidelines -* Try to follow [PSR-2 guidlines](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) -* Create pull requests against the develop branch -* Submit translations through [Transifex](https://www.transifex.com/invoice-ninja/invoice-ninja/) +### Submit pull requests + * [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` + * _Example:_ `#100-Add-GoogleAnalytics` + * Make your changes and commit + * 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/) + * _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 + +### Some rules +To make the contribution process nice and easy for anyone, please follow some rules: + * Each contribution(bug or feature) should have an [issue on Github](https://github.com/invoiceninja/invoiceninja/issues) +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 PR(pull request). Split more changes into multiple PRs. + +#### 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) + +_Example styling:_ +```php +/** + * Gets a preview of the email + * + * @param TemplateService $templateService + * + * @return \Illuminate\Http\Response + */ +public function previewEmail(TemplateService $templateService) +{ + // +} +``` + + +## Translations +For helping us with translating Invoice Ninja, please use [Transifex](https://www.transifex.com/invoice-ninja/invoice-ninja/). diff --git a/README.md b/README.md index 670fb38bba6e..e2bc81e2b63c 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,15 @@

# Invoice Ninja -### [Hosted](https://www.invoiceninja.com) | [Self-hosted](https://invoiceninja.org) [![Build Status](https://travis-ci.org/invoiceninja/invoiceninja.svg?branch=develop)](https://travis-ci.org/invoiceninja/invoiceninja) [![Join the chat at https://gitter.im/hillelcoren/invoice-ninja](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hillelcoren/invoice-ninja?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -We're often asked to recommend Laravel\PHP developers to help setup our app and make small adjustments, email us at contact@invoiceninja.com if you're interested in taking on the work. +## [Hosted](https://www.invoiceninja.com) | [Self-hosted](https://invoiceninja.org) -### Affiliates Programs +We're often asked to recommend Laravel/PHP developers to help setup our app and make small adjustments, email us at contact@invoiceninja.com if you're interested in taking on the work. + +## Affiliates Programs * Referral program (we pay you): $100 per signup paid over 3 years - [Learn more](https://www.invoiceninja.com/referral-program/) * White-label reseller (you pay us): 10% of revenue with a $500 sign up fee @@ -20,17 +21,17 @@ We're often asked to recommend Laravel\PHP developers to help setup our app and * [Bitnami](https://bitnami.com/stack/invoice-ninja) - Free * [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja) - $30 -### Requirements +## Requirements * PHP >= 5.5.9 * MCrypt PHP Extension * MySQL -### Recommended Providers +## Recommended Providers * [Stripe](https://stripe.com/) * [Postmark](https://postmarkapp.com/) -### Features +## Features * Built using Laravel 5.2 * Live PDF generation using [pdfmake](http://pdfmake.org/) * Integrates with 50+ payment providers with [Omnipay](https://github.com/thephpleague/omnipay) @@ -46,7 +47,7 @@ We're often asked to recommend Laravel\PHP developers to help setup our app and * Custom email templates * [D3.js](http://d3js.org/) visualizations -### Documentation +## Documentation * [Ubuntu and Apache](http://blog.technerdservices.com/index.php/2015/04/techpop-how-to-install-invoice-ninja-on-ubuntu-14-04/) * [Debian and Nginx](https://www.rosehosting.com/blog/install-invoice-ninja-on-a-debian-7-vps/) * [User Guide](https://www.invoiceninja.com/app-user-guide/) @@ -55,53 +56,22 @@ We're often asked to recommend Laravel\PHP developers to help setup our app and * [Support Forum](https://www.invoiceninja.com/forums/forum/support/) * [Feature Roadmap](https://trello.com/b/63BbiVVe/) -### Pull Requests -* Please create pull requests against the develop branch -* Submit translations through [Transifex](https://www.transifex.com/invoice-ninja/invoice-ninja/) +## Contributing +All contributors are welcome! +For information on how contribute to Invoice Ninja, please see our [contributing guide](CONTRIBUTING.md). -### Contributors +## Credits +* [Hillel Coren](https://github.com/hillelcoren) +* [All contributors](https://github.com/invoiceninja/invoiceninja/graphs/contributors) + +**Special thanks to:** * [Troels Liebe Bentsen](https://github.com/tlbdk) * [Jeramy Simpson](https://github.com/JeramyMywork) - [MyWork](https://www.mywork.com.au) * [Sigitas Limontas](https://lt.linkedin.com/in/sigitaslimontas) * [Joshua Dwire](https://github.com/joshuadwire) - [Some Techie](https://www.sometechie.com) +* [Holger Lösken](https://github.com/codedge) - [codedge](http://codedge.de/) -### Frameworks/Libraries -* [laravel/laravel](https://github.com/laravel/laravel) - A PHP Framework For Web Artisans -* [twbs/bootstrap](https://github.com/twbs/bootstrap) - Sleek, intuitive, and powerful front-end framework for faster and easier web development. -* [jquery/jquery](https://github.com/jquery/jquery) - jQuery JavaScript Library -* [jquery/jquery-ui](https://github.com/jquery/jquery-ui) - The official jQuery user interface library -* [patricktalmadge/bootstrapper](https://github.com/patricktalmadge/bootstrapper) - Laravel Twitter Bootstrap Bundle -* [danielfarrell/bootstrap-combobox](https://github.com/danielfarrell/bootstrap-combobox) - A combobox plugin -* [eternicode/bootstrap-datepicker](https://github.com/eternicode/bootstrap-datepicker) - A datepicker for @twitter bootstrap -* [xdan/datetimepicker](https://github.com/xdan/datetimepicker) - jQuery Plugin Date and Time Picker -* [twitter/typeahead.js](https://github.com/twitter/typeahead.js) - a fast and fully-featured autocomplete library -* [krisk/Fuse](https://github.com/krisk/Fuse) - Lightweight fuzzy-search, in JavaScript -* [knockout/knockout](https://github.com/knockout/knockout) - Knockout makes it easier to create rich, responsive UIs with JavaScript -* [rniemeyer/knockout-sortable](https://github.com/rniemeyer/knockout-sortable) - A Knockout.js binding to connect observableArrays with jQuery UI sortable functionality -* [bpampuch/pdfmake](https://github.com/bpampuch/pdfmake) - Client/server side PDF printing in pure JavaScript -* [FortAwesome/Font-Awesome](https://github.com/FortAwesome/Font-Awesome) - The iconic font designed for Bootstrap that works with twitter bootstrap -* [Anahkiasen/former](https://github.com/Anahkiasen/former) - A powerful form builder, for Laravel and other frameworks (stand-alone too) -* [barryvdh/laravel-debugbar](https://github.com/barryvdh/laravel-debugbar) - Laravel debugbar -* [DataTables/DataTables](https://github.com/DataTables/DataTables) - Tables plug-in for jQuery -* [Chumper/Datatable](https://github.com/Chumper/Datatable) - This is a laravel 4 package for the server and client side of datatables -* [omnipay/omnipay](https://github.com/omnipay/omnipay) - A framework agnostic, multi-gateway payment processing library for PHP 5.3+ -* [Intervention/image](https://github.com/Intervention/image) - PHP Image Manipulation -* [webpatser/laravel-countries](https://github.com/webpatser/laravel-countries) - Almost ISO 3166_2, 3166_3, currency, Capital and more for all countries -* [briannesbitt/Carbon](https://github.com/briannesbitt/Carbon) - A simple API extension for DateTime with PHP 5.3+ -* [thomaspark/bootswatch](https://github.com/thomaspark/bootswatch) - Themes for Bootstrap -* [mozilla/pdf.js](https://github.com/mozilla/pdf.js) - PDF Reader in JavaScript -* [nnnick/Chart.js](https://github.com/nnnick/Chart.js) - Simple HTML5 Charts using the canvas tag -* [josscrowcroft/accounting.js](https://github.com/josscrowcroft/accounting.js) - A lightweight JavaScript library for number, money and currency formatting -* [jashkenas/underscore](https://github.com/jashkenas/underscore) - JavaScript's utility _ belt -* [caouecs/Laravel4-long](https://github.com/caouecs/Laravel4-lang) - List of languages ​​for Laravel4 -* [bgrins/spectrum](https://github.com/bgrins/spectrum) - The No Hassle JavaScript Colorpicker -* [lokesh/lightbox2](https://github.com/lokesh/lightbox2/) - The original lightbox script -* [josdejong/jsoneditor](https://github.com/josdejong/jsoneditor/) - A web-based tool to view, edit and format JSON -* [simshaun/recurr](https://github.com/simshaun/recurr) - PHP library for working with recurrence rules -* [quilljs/quill](https://github.com/quilljs/quill/) - A cross browser rich text editor with an API -* [Maatwebsite/Laravel-Excel](https://github.com/Maatwebsite/Laravel-Excel) - An eloquent way of importing and exporting Excel and CSV files for Laravel -* [thephpleague/fractal](https://github.com/thephpleague/fractal) - Output complex, flexible, AJAX/RESTful data structures -* [ezyang/htmlpurifier](https://github.com/ezyang/htmlpurifier) - Standards compliant HTML filter written in PHP -* [cerdic/css-tidy](https://github.com/Cerdic/CSSTidy) - CSSTidy is a CSS minifier -* [asgrim/ofxparser](https://github.com/asgrim/ofxparser) - OFX File Parser -* [stacktracejs/stacktrace.js](https://github.com/stacktracejs/stacktrace.js) - Framework-agnostic, micro-library for getting stack traces in all web browsers + +## License +Invoice Ninja is released under the Attribution Assurance License. +See [LICENSE](LICENSE) for details. \ No newline at end of file