diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d872a4a..7e5b60e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -18,8 +18,32 @@ We accept contributions via pull requests on [GitHub](https://github.com/openmet - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting. -## Running tests +### Install development environment ```bash -$ php vendor/bin/phpunit.phar -c build/ +make install +``` + +### Run PHPStan + +```bash +make phpstan +``` + +### Run PHP-version specific tests + +```bash +make test-php-7.2 +make test-php-7.3 +make test-php-7.4 +make test-php-8.0 +make test-php-8.1 +make test-php-8.2 +make test-php-8.3 +``` + +### Run all tests + +```bash +make tests ``` diff --git a/README.md b/README.md index cfdbfea..7cdff0d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,4 @@ -[![CircleCI](https://circleci.com/gh/openmetrics-php/exposition-text.svg?style=svg)](https://circleci.com/gh/openmetrics-php/exposition-text) -[![Latest Stable Version](https://poser.pugx.org/openmetrics-php/exposition-text/v/stable)](https://packagist.org/packages/openmetrics-php/exposition-text) -[![Total Downloads](https://poser.pugx.org/openmetrics-php/exposition-text/downloads)](https://packagist.org/packages/openmetrics-php/exposition-text) -[![codecov](https://codecov.io/gh/openmetrics-php/exposition-text/branch/master/graph/badge.svg)](https://codecov.io/gh/openmetrics-php/exposition-text) -[![phpstan enabled](https://img.shields.io/badge/phpstan-enabled-green.svg)](https://github.com/phpstan/phpstan) +[![CI and release](https://github.com/openmetrics-php/exposition-text/actions/workflows/ci.yml/badge.svg)](https://github.com/openmetrics-php/exposition-text/actions/workflows/ci.yml) # OpenMetrics-PHP Exposition Text @@ -24,9 +20,15 @@ into existing frameworks / code bases. **Please note:** that the following content-type header is used for the HTTP response by default `Content-Type: application/openmetrics-text; charset=utf-8` as [discussed here](https://github.com/OpenObservability/OpenMetrics/issues/79). -## Requirements +## Supported PHP Versions -* PHP >= 7.1 +* 7.2 +* 7.3 +* 7.4 +* 8.0 +* 8.1 +* 8.2 +* 8.3 ## Installation @@ -261,7 +263,6 @@ your_metric_name_summary_count 10 ## Contributing -Contributions are welcome and will be fully credited. +Contributions are welcome and will be fully credited. Please see the [contribution guide](.github/CONTRIBUTING.md) for details. -