1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-10 05:02:36 +01:00

Create README.md

This commit is contained in:
David Bomba 2018-10-05 17:39:34 +10:00 committed by GitHub
parent e88604594b
commit 768dd63350
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

23
README.md Normal file
View File

@ -0,0 +1,23 @@
**Invoice Ninja v 5.0**
Invoice Ninja v 5.0 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.1 allows the return type Nullable so there should be no circumstance a type cannot be return by using the following:
`public function doThat() ?:string`
Please include tests with PRs to ensure your code works well and integrates with the rest of the project. Please ensure suitable unit/functional/acceptance tests are included to provide code coverage.