Skip to content

Commit

Permalink
TL: minor doc update
Browse files Browse the repository at this point in the history
tlunet committed Jun 23, 2024
1 parent 92ca00e commit f791e3b
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ Chosen merge strategy is to squash commits $\Rightarrow$ you don't have to care

> 🔔 Once your PR is accepted, please delete this branch from your fork and synchronize your `main` branch. When creating a new development branch later, ensure that you start from an up-to-date `main` branch of your fork.
In case you are interested in contributing but don't have any idea on what, checkout out [current development roadmap 🎯](./devdoc/roadmap.md) and the current [project proposals 🎓](https://github.com/Parallel-in-Time/qmat/discussions/categories/project-proposals)
In case you are interested in contributing but don't have any idea on what, checkout out current [development roadmap 🎯](./devdoc/roadmap.md) and [project proposals 🎓](https://github.com/Parallel-in-Time/qmat/discussions/categories/project-proposals)

## Base recipes

4 changes: 2 additions & 2 deletions docs/devdoc/versionUpdate.md
Original file line number Diff line number Diff line change
@@ -3,15 +3,15 @@
## Release conventions

See full [development roadmap](./roadmap.md) for past and planned features corresponding to each versions.
We use the following denomination for each version update (_a.k.a_ releases) :
For each version update (_a.k.a_ releases) **after reaching Mature status (6)**, we use the following denomination :

- patch : from `*.*.{i}` to `*.*.{i+1}` $\Rightarrow$ minor modifications, bugfixes, code reformating, additional aliases for generators
- minor : from `*.{i}.*` to `*.{i+1}.0` $\Rightarrow$ addition of new generators, new utility functions, new scripts, ...
- major : from `{i}.*.*` to `{i+1}.0.0` $\Rightarrow$ major changes in code structure, design and API

Here are some generic recommendation on release-triggering events :

1. patch version should be released every three months in case some only patch-type commits have been done
1. patch version should be released every three months in case some only patch-type changes have been done
2. minor version should be released after merging a PR including new features (requires a version dump commit, see below ...)
3. major version are released when important changes have been done on a development branch named `v{i+1}-dev` hosted on the main repo. Requires a full update of the documentation and code, eventually some migration guide, etc ... Before merging `v{i+1}-dev` into `main`, a `v{i}-lts` branch is created from it to keep track of the old version, and eventually update it with some minor or patch releases until a pre-defined deprecation date defined in `docs/SECURITY.md`.

4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -52,11 +52,11 @@ which are key elements for Spectral Deferred Correction (SDC), or more general I
</a>


Package can be installed using `pip` :
This package can be installed using `pip` :

.. code-block:: bash
pip install qmat # basic installation through
pip install qmat
... but you can also use `conda` or installation from sources, see the :doc:`Installation Instructions 💾<installation>`

0 comments on commit f791e3b

Please sign in to comment.