From 0573e32ceb409a96deccd24849f410d830685f0c Mon Sep 17 00:00:00 2001 From: Lucas Cimon <925560+Lucas-C@users.noreply.github.com> Date: Fri, 29 Jan 2021 11:41:38 +0100 Subject: [PATCH] Adding CODEOWNERS, CONTRIBUTING.md & release checklist --- CHANGELOG.md | 2 +- CODEOWNERS | 3 +++ CONTRIBUTING.md | 3 +++ README.md | 5 +---- docs/Development.md | 23 ++++++++++++++++++----- fpdf/fpdf.py | 2 +- 6 files changed, 27 insertions(+), 11 deletions(-) create mode 100644 CODEOWNERS create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 12e50cfff..26745ca37 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/), and [PEP 440](https://www.python.org/dev/peps/pep-0440/). -## [2.2.1] - Not released yet +## [2.3.0] - 2021-01-29 ### Added - `FPDF.unbreakable` : a new method providing a context-manager in which automatic page breaks are disabled. _cf._ https://pyfpdf.github.io/fpdf2/PageBreaks.html diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 000000000..96407b31e --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,3 @@ +# cf. https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners + +* @Lucas-C @alexanderankin diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5dd65b257 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +Please check [the documentation page dedicated to development](https://pyfpdf.github.io/fpdf2/Development.html). + +This library was only possible thanks to the dedication of the following people: [CONTRIBUTORS.md](CONTRIBUTORS.md). diff --git a/README.md b/README.md index 9a285833c..59e07327e 100644 --- a/README.md +++ b/README.md @@ -84,13 +84,10 @@ You can also have a look at the `tests/`, they're great usage examples! Developers: ----------- -Please check [the docs page dedicated to development](https://pyfpdf.github.io/fpdf2/Development.html). +Please check [the documentation page dedicated to development](https://pyfpdf.github.io/fpdf2/Development.html). This library was only possible thanks to the dedication of the following people: [CONTRIBUTORS.md](CONTRIBUTORS.md). -Lets try to improve the Code Coverage statistic so that we can safely -transition to external font and image libraries, and more... - Other libraries --------------- diff --git a/docs/Development.md b/docs/Development.md index 061ad693b..5dccaeb2a 100644 --- a/docs/Development.md +++ b/docs/Development.md @@ -44,11 +44,15 @@ Some are also listed on [its libraries.io page](https://libraries.io/pypi/fpdf2) * `[scripts]` - manipulate this repository * `[test]` - tests * `[tutorial]` - tutorials (see also [Tutorial](Tutorial.md)) - * `README.md`, `PyPIReadme.rst` - Github and PyPI Readme's. - * `LICENSE` - license information - * `setup.cfg`, `setup.py`, `MANIFEST.in` - setup configuration - * `mkdocs.yml` - config for [MkDocs](https://www.mkdocs.org/) - * `tox.ini` - config for [Tox](https://tox.readthedocs.io/en/latest/) + * `README.md` - Github and PyPI ReadMe + * `CHANGELOG.md` - details of each release content + * `LICENSE` - code license information + * `CODEOWNERS` - define individuals or teams responsible for code in this repository + * `CONTRIBUTORS.md` - the people who helped build this library ❤️ + * `setup.cfg`, `setup.py`, `MANIFEST.in` - packaging configuration to publish [a package on Pypi](https://pypi.org/project/fpdf2/) + * `mkdocs.yml` - configuration for [MkDocs](https://www.mkdocs.org/) + * `tox.ini` - configuration for [Tox](https://tox.readthedocs.io/en/latest/) + * `.pylintrc` - configuration for [Pylint](http://pylint.pycqa.org/en/latest/) ## Code auto-formatting ## @@ -132,6 +136,15 @@ linting with `pylint`, unit tests... _Pull Requests_ submitted must pass all those checks in order to be approved. Ask maintainers through comments if some errors in the pipeline seem obscure to you. +### Release checklist ### + +1. complete `CHANGELOG.md` and add the version & date of the new release +2. bump `FPDF_VERSION` in `fpdf/fpdf.py` +3. `git commit` & `git push` +4. check that [the GitHub Actions succeed](https://github.com/PyFPDF/fpdf2/actions), and that [a new release appears on Pypi](https://pypi.org/project/fpdf2/#history) +5. perform a [GitHub release](https://github.com/PyFPDF/fpdf2/releases), taking the description from the `CHANGELOG.md`. +It will create a new `git` tag. + ## Documentation ## The standalone documentation is in the `docs` subfolder, diff --git a/fpdf/fpdf.py b/fpdf/fpdf.py index c9c3ef945..42e6376a0 100644 --- a/fpdf/fpdf.py +++ b/fpdf/fpdf.py @@ -53,7 +53,7 @@ HERE = Path(__file__).resolve().parent # Global variables -FPDF_VERSION = "2.2.0" +FPDF_VERSION = "2.3.0" FPDF_FONT_DIR = HERE / "font" FPDF_CACHE_MODE = 0 # 0 - in same folder, 1 - none, 2 - hash FPDF_CACHE_DIR = None