Skip to content

Added contributing.md for php-laravel #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added contributing.md for php-laravel #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions php/sqlcommenter-php/packages/sqlcommenter-laravel/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing to php-laravel

The contributions for Sqlcommenter laravel should be made to this [repo](https://github.com/google/sqlcommenter)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Period at the end of line.


## 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"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the suffix can imitate the laravel package. Maybe something like: /<full or relative path to local repository>/php/sqlcommenter-php/packages/sqlcommenter-laravel/package ?

}
]
```

```shell
composer require "google/sqlcommenter-laravel"
```
## Run Unittests
Run unit tests using below command
```shell
./vendor/bin/phpunit tests
```
3 changes: 3 additions & 0 deletions php/sqlcommenter-php/packages/sqlcommenter-laravel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,6 @@ With Laravel SqlCommenter, we have configuration to choose which tags to be appe
| `framework` | <div style="text-align: center">&#10004;</div> | The word "laravel" and the version of laravel being used |
| `route` | <div style="text-align: center">&#10004;</div> | The [route](https://laravel.com/docs/9.x/routing) of the matching URL pattern as described in your routes/api.php |
| `traceparent` | <div style="text-align: center">&#10004;</div> | 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)