From c2d05a9914bff9e2a2965938f373a041c761f067 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20M=C3=B6ller?= Date: Tue, 27 Feb 2024 17:31:32 +0100 Subject: [PATCH] Enhancement: Add CONTRIBUTING.md --- .github/CONTRIBUTING.md | 19 +++++++++++++++++++ README.md | 4 ++++ 2 files changed, 23 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..b6adb52 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# CONTRIBUTING + +We use [GitHub Actions](https://github.com/features/actions) as a continuous integration system. + +For details, take a look at the following workflow configuration files: + +- [`workflows/integrate.yaml`](workflows/integrate.yaml) + +## Tests + +We use [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development. + +Run + +```sh +vendor/bin/phpunit --configuration=tests/phpunit.xml +``` + +to run all the tests. diff --git a/README.md b/README.md index ec416f9..6c8c6bc 100755 --- a/README.md +++ b/README.md @@ -821,6 +821,10 @@ You can now run through the result and put it formatted into a drop-down field o ------------------------------------------------- +# Contributing + +The maintainers of this project suggest following the [contribution guide](.github/CONTRIBUTING.md). + # License Moment.php is freely distributable under the terms of the MIT license.