Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
riticksingh committed Nov 18, 2020
1 parent ffae565 commit 1cc76d4
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ We use docker and docker-compose to perform a lot of our static analysis and tes
If you're planning to develop for this library, it'll help to install `docker engine` and `docker-compose`.
You can find installation instructions for these packages can be found [here](https://docs.docker.com/install/), under the `Docker Engine` and `Docker Compose` submenus respectively.

##Proto Generation
In order to generate proto files for use with this repository, we can perform a

`make proto`

From the root directory. This wil create a `/proto` folder in the root directory of the repository.

## Styling
We use [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) for our code linting and standards fixer. The associated configuration for this standards fixer can be found in the root of the repository [here](https://github.com/open-telemetry/opentelemetry-php/blob/master/.php_cs)

Expand Down

0 comments on commit 1cc76d4

Please sign in to comment.