diff --git a/.github/workflows/build-doctum-docs.yml b/.github/workflows/build-doctum-docs.yml index 58b93f86f..a706c8d5a 100644 --- 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 new file mode 100644 index 000000000..f4e9fea06 --- /dev/null +++ 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 \ No newline at end of file