diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..30eb9b8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ + + +# Changelog + +## 2023-11-06 + +- [Improvement] Recommend putting job scripts under "tasks" directory instead of "jobs", for consistency with official plugins (by @CodeWithEmad). +- [Improvement] Start keeping a changelog (by @kdmccormick). diff --git a/README.rst b/README.rst index d2d5913..d15e821 100644 --- a/README.rst +++ b/README.rst @@ -159,10 +159,17 @@ The plugin API was upgraded from v0 to v1 in Tutor v13.2.0. This cookiecutter ge Troubleshooting --------------- -This Tutor plugin template is maintained by `Kyle McCormick `_ from the `The Center for Reimagining Learning (tCRIL) `_. Community support is available from the official `Open edX forum `_. +This Tutor plugin template is maintained by `Kyle McCormick `_ from `Axim Collaborative `_. Community support is available from the official `Open edX forum `_. Do you need help using this template? See the `troubleshooting `__ section from the Tutor documentation. +Contributing +------------ + +Pull requests are welcome! Please read the `"contributing" section from the Tutor documentation `__. + +Unlike other Tutor repositories, you do not need to run ``make changelog-entry``. Instead, simply edit CHANGELOG.md to note any changes that might affect plugin developers using the cookiecutter. + License -------