Skip to content

Commit

Permalink
docs: start a simple Changelog (#24)
Browse files Browse the repository at this point in the history
We are using a simple Changelog.md instead of using scriv
because the cookiecutter doesn't have a versioned release
process.
Discussion at:
#22 (comment)

Includes a starter entry from:
#23
  • Loading branch information
kdmccormick authored Nov 7, 2023
1 parent a22ff10 commit 7767887
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!--
Create a changelog entry for every new user-facing change (where the "users" are plugin developers).
Please respect the following instructions:
- Group changes by date, with newest changes first.
- Prefix your changes with either [Bugfix], [Improvement], [Feature], [Security], [Deprecation].
- You may optionally append "(by @<author>)" at the end of the line, where "<author>" is either one (just one)
of your GitHub username, real name or affiliated organization. -->

# 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).
9 changes: 8 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/kdmccormick>`_ from the `The Center for Reimagining Learning (tCRIL) <https://openedx.atlassian.net/wiki/spaces/COMM/pages/3241640370/tCRIL+Engineering+Team>`_. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`_.
This Tutor plugin template is maintained by `Kyle McCormick <https://github.com/kdmccormick>`_ from `Axim Collaborative <https://axim.org>`_. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`_.

Do you need help using this template? See the `troubleshooting <https://docs.tutor.overhang.io/troubleshooting.html>`__ section from the Tutor documentation.

Contributing
------------

Pull requests are welcome! Please read the `"contributing" section from the Tutor documentation <https://docs.tutor.overhang.io/tutor.html#contributing>`__.

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
-------

Expand Down

0 comments on commit 7767887

Please sign in to comment.