invoiceninja/README.md

<p align="center">
    <img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/>
</p>

[![Build Status](https://travis-ci.org/invoiceninja/invoiceninja.svg?branch=v2)](https://travis-ci.org/invoiceninja/invoiceninja)
[![codecov](https://codecov.io/gh/invoiceninja/invoiceninja/branch/v2/graph/badge.svg)](https://codecov.io/gh/invoiceninja/invoiceninja)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d39acb4bf0f74a0698dc77f382769ba5)](https://www.codacy.com/app/turbo124/invoiceninja?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=invoiceninja/invoiceninja&amp;utm_campaign=Badge_Grade)

**Invoice Ninja v 2** is coming soon!

We will be using the lessons learnt in Invoice Ninja 4.0 to build a bigger better platform to work from. If you would like to contribute to the project we will gladly accept contributions for code, user guides, bug tracking and feedback! Please consider the following guidelines prior to submitting a pull request:

# Contribution guide.

Code Style to follow [PSR-2](https://www.php-fig.org/psr/psr-2/) standards.

All methods names to be in CamelCase

All variables names to be in snake_case

Where practical code should be strongly typed, ie your methods must return a type ie

`public function doThis() : void`

PHP >= 7.3 allows the return type Nullable so there should be no circumstance a type cannot be return by using the following:

`public function doThat() ?:string`

To improve chances of PRs being merged please include teststo ensure your code works well and integrates with the rest of the project.


# Documentation

API documentation is hosted using Swagger and can be found [HERE](https://app.swaggerhub.com/apis-docs/InvoiceNinja/InvoiceNinjaV2/1.0.3)
Update README.md 2018-10-05 09:52:12 +02:00			`<p align="center">`
			`<img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/>`
			`</p>`
Create README.md 2018-10-05 09:39:34 +02:00
V2 First Push 2019-03-26 04:08:19 +01:00			`[![Build Status](https://travis-ci.org/invoiceninja/invoiceninja.svg?branch=v2)](https://travis-ci.org/invoiceninja/invoiceninja)`
Update README.md 2019-04-20 00:58:01 +02:00			`[![codecov](https://codecov.io/gh/invoiceninja/invoiceninja/branch/v2/graph/badge.svg)](https://codecov.io/gh/invoiceninja/invoiceninja)`
Improve code coverage (#2424) 2018-10-05 14:46:53 +02:00			`[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d39acb4bf0f74a0698dc77f382769ba5)](https://www.codacy.com/app/turbo124/invoiceninja?utm_source=github.com&utm_medium=referral&utm_content=invoiceninja/invoiceninja&utm_campaign=Badge_Grade)`
Exclude laravel from code coverage (#2425) * exclude laravel from coverage * exclude laravel from coverage 2018-10-05 14:59:26 +02:00
V2 First Push 2019-03-26 04:08:19 +01:00			`Invoice Ninja v 2 is coming soon!`
Create README.md 2018-10-05 09:39:34 +02:00
			`We will be using the lessons learnt in Invoice Ninja 4.0 to build a bigger better platform to work from. If you would like to contribute to the project we will gladly accept contributions for code, user guides, bug tracking and feedback! Please consider the following guidelines prior to submitting a pull request:`

			`# Contribution guide.`

			`Code Style to follow [PSR-2](https://www.php-fig.org/psr/psr-2/) standards.`

			`All methods names to be in CamelCase`

			`All variables names to be in snake_case`

			`Where practical code should be strongly typed, ie your methods must return a type ie`

			`public function doThis() : void`

Update README.md 2019-07-09 11:43:24 +02:00			`PHP >= 7.3 allows the return type Nullable so there should be no circumstance a type cannot be return by using the following:`
Create README.md 2018-10-05 09:39:34 +02:00
			`public function doThat() ?:string`

Generated Datatable Action Menus (#2590) * Style Datatable * Component Actions * Harvest user permissions from Pivot table * Pad out permissions * Client actions * Fixes for travis * Client Datatables * Menu permissions * Tests for menu permissions * Action menu * Implement query builder filter * Flatten user permissions * Implement rendering of client action dropdowns * Generated Action Menus 2019-01-07 12:30:28 +01:00			`To improve chances of PRs being merged please include teststo ensure your code works well and integrates with the rest of the project.`
Update README.md 2019-08-26 03:12:37 +02:00

			`# Documentation`

			`API documentation is hosted using Swagger and can be found [HERE](https://app.swaggerhub.com/apis-docs/InvoiceNinja/InvoiceNinjaV2/1.0.3)`