Create CONTRIBUTING.md

thomaseizinger · Jul 22, 2021 · 2d426a4 · 2d426a4
1 parent 296164f
commit 2d426a4
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,17 @@
+# Contributing
+
+Thank you for wanting to contribute!
+
+This action has a set of integration tests that are unfortunately a bit tricky to run due to how GitHub handles permissions.
+
+There are two sets of workflows:
+
+1. Basic checks which run on every PR.
+2. Integration tests which run only on the master branch.
+
+To make it easier to merge contributions, please:
+
+- Make pull requests from _your fork's master branch_.
+- Enable actions on your fork.
+
+This allows the integration tests to run on your fork, making it possible to see that a change works before merging it into `master` here.