Merge pull request #1540 from LowerRockLabs/v3-minorTweak

Add Contributing Guide
rappasoft · Nov 5, 2023 · 4f95d8d · 4f95d8d
2 parents 435f5c4 + 52f7352
commit 4f95d8d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.github/workflows/build-doctum-docs.yml b/.github/workflows/build-doctum-docs.yml
@@ -14,7 +14,7 @@ jobs:
               # The branch, tag or SHA to checkout. When checking out the repository that
               # triggered a workflow, this defaults to the reference or SHA for that event.
               # Otherwise, uses the default branch.
-              ref: 'master'
+              ref: 'develop'
 
           - name: build doctum docs
             uses: sudo-bot/action-doctum@latest

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+# Contributing
+Contributions are very welcome, please find below a summary of what is expected from contributions:
+
+- Follow the conventions for methods, adding to the relevant configuration/helper trait
+- Add properties to the "With" trait
+- Typehint both properties and return values
+- Add a comment to the method
+- Add tests for new methods
+- Add documentation for new methods