overhangio / tutor-ecommerce

Ecommerce plugin for Tutor
GNU Affero General Public License v3.0
17 stars 50 forks source link

feat: add a scriv-based changelog #39

Closed regisb closed 1 year ago

regisb commented 1 year ago

This is to address https://github.com/overhangio/tutor/issues/746

regisb commented 1 year ago

@overhangio/tutor-maintainers could you please review this PR? If you're happy with the proposed changes, please open a similar PR in the repos you maintain. Thanks!

arbrandes commented 1 year ago

For tutor-mfe: https://github.com/overhangio/tutor-mfe/issues/118

ghassanmas commented 1 year ago

I wonder would it be okay to change the Readme file extension from rst to md? Would that have any consequences long or short term

regisb commented 1 year ago

I wonder would it be okay to change the Readme file extension from rst to md? Would that have any consequences long or short term

There are no serious consequences that I can think of. I picked rst as a README format early on, because in my experience this makes it much easier to convert a long readme to a full sphinx-compatible docs site. I'm not sure I would agree on an rst -> md conversion, but we can certainly discuss it.