CONTRIBUTING.md

Contribution Guide

Hello, thanks for wanting to contribute. Here are a few things you should know ...

For fixes

• Checkout edge branch
• Look through the existing issues to be sure a similar issues does not exist
• Create an issue
• Make a PR to the edge branch with a clear description that references the issue you created

For enhancements

• Checkout edge branch
• Create an issue
  • We'll discuss its importance
• Make a PR to the edge branch

Generating API Documentation

Our Rest API Documentation is auto-generated by this package, using the application's

• Laravel Routes
• Controller Actions'
  • Arguments
  • Comments

If you make a change and need to generate the docs, run

php artisan generate:docs <email>

This command will request for the password for the admin email you have provided, and if authenticated, will generate the documentation.

Testing

We make use of PHPUnit and PHPUnit-Watcher, so you can watch your PHP tests with npm run watch-php as you work.