From b12e6efb9744d2ef2f05953f93f5b3c5031a8a76 Mon Sep 17 00:00:00 2001 From: Thiyagu55 Date: Thu, 1 Sep 2022 16:35:26 +0530 Subject: [PATCH] Added contributing.md --- .../sqlcommenter-laravel/CONTRIBUTING.md | 30 +++++++++++++++++++ .../packages/sqlcommenter-laravel/README.md | 3 ++ 2 files changed, 33 insertions(+) create mode 100644 php/sqlcommenter-php/packages/sqlcommenter-laravel/CONTRIBUTING.md diff --git a/php/sqlcommenter-php/packages/sqlcommenter-laravel/CONTRIBUTING.md b/php/sqlcommenter-php/packages/sqlcommenter-laravel/CONTRIBUTING.md new file mode 100644 index 00000000..b99e7e45 --- /dev/null +++ b/php/sqlcommenter-php/packages/sqlcommenter-laravel/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to php-laravel + +The contributions for Sqlcommenter laravel should be made to this [repo](https://github.com/google/sqlcommenter) + +## Download Source + +```shell +git clone https://github.com/google/sqlcommenter +``` + +## Install from source + +Add this to your `composer.json` +```shell +"repositories": [ + { + "type": "path", + "url": "/full/or/relative/path/to/sqlcommenter-laravel/package" + } +] +``` + +```shell +composer require "google/sqlcommenter-laravel" +``` +## Run Unittests +Run unit tests using below command +```shell +./vendor/bin/phpunit tests +``` \ No newline at end of file diff --git a/php/sqlcommenter-php/packages/sqlcommenter-laravel/README.md b/php/sqlcommenter-php/packages/sqlcommenter-laravel/README.md index d0e8255c..64cbc99c 100644 --- a/php/sqlcommenter-php/packages/sqlcommenter-laravel/README.md +++ b/php/sqlcommenter-php/packages/sqlcommenter-laravel/README.md @@ -39,3 +39,6 @@ With Laravel SqlCommenter, we have configuration to choose which tags to be appe | `framework` |
| The word "laravel" and the version of laravel being used | | `route` |
| The [route](https://laravel.com/docs/9.x/routing) of the matching URL pattern as described in your routes/api.php | | `traceparent` |
| The [W3C TraceContext.Traceparent field](https://www.w3.org/TR/trace-context/#traceparent-field) of the OpenTelemetry trace | + +## Contributing +See [CONTRIBUTING.md](https://github.com/google/sqlcommenter/blob/master/php/sqlcommenter-php/packages/sqlcommenter-laravel/CONTRIBUTING.md) \ No newline at end of file