diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 37857e0f..8976d7a6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,13 +6,13 @@ repos: - id: end-of-file-fixer - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.1.8 + rev: v0.3.4 hooks: - id: ruff args: [--fix] - repo: https://github.com/psf/black - rev: 23.12.0 + rev: 24.3.0 hooks: - id: black language_version: python3 diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ae672ff5..61deb3ef 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -237,6 +237,8 @@ Refer to the table below for a comprehensive summary of all CI tools employed to +----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | `CodeFactor `__ | Automated code review and analysis tools | +----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| `Codacy `__ | Automated code review and analysis tools | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ 5. Code testing with pytest diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 20e3a759..4c1437ff 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -128,7 +128,7 @@ You can create a conda environment (i.e. with python 3.11) with: conda create --name disdrodb-dev-py311 python=3.11 --no-default-packages conda activate disdrodb-dev-py311 -Install the disdrodb package dependencies +Install the package dependencies ............................................ .. code-block:: bash @@ -136,7 +136,7 @@ Install the disdrodb package dependencies conda install --only-deps disdrodb -Install the disdrodb package in editable mode +Install the package in editable mode ................................................ Install the disdrodb package in editable mode by executing the following command in the disdrodb repository's root: @@ -146,7 +146,7 @@ Install the disdrodb package in editable mode by executing the following command pip install -e ".[dev]" -Install pre-commit code quality checks +Install code quality checks .............................................. Install the pre-commit hook by executing the following command in the disdrodb repository's root: diff --git a/docs/source/maintainers_guidelines.rst b/docs/source/maintainers_guidelines.rst index c4e5ad7d..b453ca95 100644 --- a/docs/source/maintainers_guidelines.rst +++ b/docs/source/maintainers_guidelines.rst @@ -6,14 +6,14 @@ Maintainers Guidelines The section is dedicated to the DISDRODB core developers (maintainers). -List of the core contributors +Core contributors ================================= * Current Release Manager : Ghiggi Gionata * Testing Team : Ghiggi Gionata -Versions guidelines +Versions Guidelines ======================== DISDRODB uses `Semantic `_ Versioning. Each release is associated with a git tag of the form X.Y.Z. @@ -68,7 +68,7 @@ styled with `Book Theme `__ @@ -124,7 +124,7 @@ This webhook is linked to the DISDRODB core developer. Ghiggi Gionata owns the `ReadTheDoc `__ account. -Package release +Package Release ================== A `GitHub Action `_ is configured to automate the packaging and uploading process @@ -144,7 +144,7 @@ Once the conda-forge recipe is updated, a new conda-forge package is released. The PyPI project and the conda-forge recipes are collaboratively maintained by core contributors of the project. -Release process +Release Process ---------------- Before releasing a new version, the ``CHANGELOG.md`` file should be updated. Run @@ -174,7 +174,7 @@ Create a new tag to trigger the release process. On GitHub, edit the release description to add the list of changes from the ``CHANGELOG.md`` file. -Reviewing process +Reviewing Process ==================== @@ -190,7 +190,7 @@ The review process is the following: -Continuous integration +Continuous Integration ======================= Continuous Integration (CI) is a crucial practice in modern software development, ensuring that code changes are regularly integrated into the main codebase. @@ -218,9 +218,11 @@ The table below summarizes the software tools utilized in our CI pipeline, descr +----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | `Coveralls `__ | Uses Coverage to track and analyze code coverage over time. | `disdrodb `__ | +----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| `CodeBeat `__ | Automated code review and analysis tools | `disdrodb `__ | +| `CodeBeat `__ | Automated code review and analysis tools | `disdrodb `__ | +----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | `CodeScene `__ | Automated code review and analysis tools | `disdrodb `__ | +----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | `CodeFactor `__ | Automated code review and analysis tools | `disdrodb `__ | +----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| `Codacy `__ | Automated code review and analysis tools | `disdrodb `__ | ++----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+