From 95783bc284c8c0ab17125ac439038cabe33edc63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20Rosado?= Date: Thu, 29 Dec 2022 23:07:39 +0000 Subject: [PATCH] Add changelog to docs (#1066) --- CONTRIBUTING.md | 2 +- docs/changelog.md | 16 ++++++++++++++++ docs/development/developing.md | 27 +++++++++++++++++++++++++++ docs/index.md | 1 + docs/tutorials/index.md | 1 + 5 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 docs/changelog.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03588c18..beea8d56 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ Thank you for wanting to contribute to the PyScript project! * [Asking questions](#asking-questions) * [Setting up your local environment and developing](#setting-up-your-local-environment-and-developing) * [Places to start](#places-to-start) - * [Submitting a change](#submitting-a-change) + * [Setting up your local environment and developing](#setting-up-your-local-environment-and-developing) * [License terms for contributions](#license-terms-for-contributions) * [Becoming a maintainer](#becoming-a-maintainer) * [Trademarks](#trademarks) diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 00000000..5be8340c --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,16 @@ +# Release Notes + +2023.01.1 +========= + +Bug fixes +--------- + +- Fixed an issue where `pyscript` would not be available when using the minified version of PyScript. ([#1054](https://github.com/pyscript/pyscript/pull/1054)) +- Fixed missing closing tag when rendering an image with `display`. ([#1058](https://github.com/pyscript/pyscript/pull/1058)) +- Fixed a bug where Python plugins methods were being executed twice. ([#1064](https://github.com/pyscript/pyscript/pull/1064)) + +Documentation +------------- + +- Fixed 'Direct usage of document is deprecated' warning in the getting started guide. ([#1052](https://github.com/pyscript/pyscript/pull/1052)) diff --git a/docs/development/developing.md b/docs/development/developing.md index 44d14736..40a98165 100644 --- a/docs/development/developing.md +++ b/docs/development/developing.md @@ -46,6 +46,33 @@ make tests * When you make changes locally, double check that your contribution follows the PyScript formatting rules by running `npm run lint`. Note that in this case you're looking for the errors, **NOT** the warnings (Unless the warning is created by a local change). If an error is found by lint you should fix it **before** creating a pull request +## Updating the changelog + +As you work on your changes, please update the changelog file `changelog.md` with a short description of the changes you made. This will help us keep track of what has changed in each release. + +You can look at the [changelog](../changelog.md) for examples on how to add your changes to the changelog. But here's a quick example: + +``` +2023.02.01 +========= + +Bug fixes +--------- + +- Fixed a bug that was causing the app to crash when you tried to do something #PR_NUMBER + +Enhancements +------------ + +- Made awesome new feature #PR_NUMBER + +Documentation +------------- + +- Added a new section to the docs #PR_NUMBER + +``` + ## Rebasing changes diff --git a/docs/index.md b/docs/index.md index 55f6f43a..72aa2342 100644 --- a/docs/index.md +++ b/docs/index.md @@ -54,4 +54,5 @@ tutorials/index guides/index concepts/index reference/index +changelog ``` diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index 7230774d..46de8078 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -5,6 +5,7 @@ This is the tutorials section for beginners. ```{toctree} --- maxdepth: 2 +glob: --- getting-started py-config-fetch