Enhancement: Add CONTRIBUTING.md

fightbulc · Feb 27, 2024 · c2d05a9 · c2d05a9
1 parent 138d838
commit c2d05a9
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md 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
@@ -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.