From 1417df231565befccfe8c6633008a2f3e7539b45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20Taymans?= Date: Tue, 8 Oct 2024 12:03:11 +0200 Subject: [PATCH] [DOC] explain newsfragments usage in dev doc --- DEVELOP.md | 31 +++++++++++++++++++++++++++++++ newsfragments/+update-dev-doc.doc | 1 + 2 files changed, 32 insertions(+) create mode 100644 newsfragments/+update-dev-doc.doc diff --git a/DEVELOP.md b/DEVELOP.md index 51f46cd..866e315 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -88,6 +88,37 @@ docker exec -it POSTGRES_CONTAINER_NAME /bin/bash # Contribute +## Provide newsfragments in your merge requests + +If you propose a merge request, please add a newsfragments with it. + +A newsfragment is a small file describing what is done in the merge +request. The file has a extension (e.g. `.feature`, `.bugfix`, etc) that +describe witch type of modification you are doing. This newsfragment +file will populate the CHANGES.rst file for the next release. +Documentation and the full list of default available extension can be +found [here](https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments). + +Newsfragments must be put in the `newsfragments` directory at the root +of the project. You can install `towncrier` via `pipx install +towncrier`. + +The newsfragments file will be processed with `towncrier` by the +maintainers during the release process. + +Use `towncrier create --help` to see the available extension for the +newsfragement files. The name of the file can be a number referring an +issue of the project or a +[slug](https://en.wikipedia.org/wiki/Clean_URL#Slug) that start with +a `+` symbol. + +This is a example of newsfragments. + +`newsfragments/+sub-command-cowsay.feature`: +``` +Adds a new subcommand `cowsay` to allow poeple to speak like a cow. +``` + ## Add python dependencies If you add new dependencies, you have to: diff --git a/newsfragments/+update-dev-doc.doc b/newsfragments/+update-dev-doc.doc new file mode 100644 index 0000000..b77c854 --- /dev/null +++ b/newsfragments/+update-dev-doc.doc @@ -0,0 +1 @@ +Add towncrier and newsfragments info in dev documentation.