Skip to content

Commit

Permalink
Adding CODEOWNERS, CONTRIBUTING.md & release checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucas-C committed Jan 29, 2021
1 parent 9fb2c3b commit 0573e32
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# cf. https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners

* @Lucas-C @alexanderankin
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
23 changes: 18 additions & 5 deletions docs/Development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ##

Expand Down Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion fpdf/fpdf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0573e32

Please sign in to comment.