gh-172: repository cleanup

.github/workflows/release.yml

@@ -17,4 +17,4 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - run: pipx run build
-      - uses: pypa/gh-action-pypi-publish@v1.8
+      - uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test.yml → .github/workflows/tests.yml

@@ -1,4 +1,4 @@
-name: Test
+name: Tests
 
 on:
   push:
@@ -32,8 +32,9 @@ jobs:
 
       - name: Run pre-commit
         run: pre-commit run --all-files --color always
-  tests:
-    name: Tests
+
+  test:
+    name: Test
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -49,6 +50,7 @@ jobs:
       - run: pip install -c .github/test-constraints.txt '.[test]'
       - run: pytest --cov=heracles --cov-report=lcov
       - uses: coverallsapp/github-action@v2
+
   build:
     name: Build
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -10,37 +10,17 @@ existing issue. The only exception are minor, obvious changes such as fixing
 typos in the documentation.
 
 The discussion in a pull request should only be about the low-level details of
-its implementation. All high-level, conceptual discussion belongs to the issue
-to which the pull request refers.
+its implementation. All high-level, conceptual discussion belongs in the issue
+that is addressed by the pull request.
 
 ## Pull requests
 
 Pull requests to the `main` branch should have titles of the following form:
 
-    TYPE: Subject line
+    gh-NN: Subject line
 
-The title can optionally refer to the module which is being changed:
-
-    TYPE(module): Subject line
-
-The `TYPE` prefix should indicate the nature of the change and must be taken
-from the following list:
-
-    API -- an (incompatible) API change
-    BUG -- bug fix
-    DEP -- deprecate something, or remove a deprecated object
-    DEV -- development infrastructure (tools, packaging, etc.)
-    DOC -- documentation
-    ENH -- enhancement
-    MNT -- maintenance commit (refactoring, typos, etc.)
-    REV -- revert an earlier commit
-    STY -- style fix (whitespace, PEP8)
-    TST -- addition or modification of tests
-    TYP -- static typing
-    REL -- related to releasing Heracles
-
-The optional `module` tag should indicate which modules are affected by the
-change, and refer to an existing module name.
+The prefix `gh-NN` should refer to the issue number (`NN`) that is addressed
+by the pull request.
 
 The body of the pull request should contain a description of the changes, and
 any relevant details or caveats of the implementation.
@@ -61,47 +41,19 @@ a single GitHub issue number:
 
     Closes: #17
 
-Changelog entries are collected using the following trailers, and later parsed
-into the [changelog](CHANGELOG.md) for the next release:
-
-    Added: Some new feature
-    Changed: Some change in existing functionality
-    Deprecated: Some soon-to-be removed feature
-    Removed: Some now removed feature
-    Fixed: Some bug fix
-    Security: Some vulnerability was fixed
-
 You can use any of the other common git trailers. In particular, you can use
 `Cc` to notify others of your pull request via their GitHub usernames:
 
     Cc: @octocat
 
 ## Versioning
 
-The current version number is automatically inferred from the last release
-(i.e. git tag), subsequent unreleased commits, and local changes, if any.
+The current version number is automatically inferred from the last release,
+subsequent unreleased commits, and local changes, if any.
 
 ## Releasing
 
-To release a new version of _Heracles_, there should be a commit titled
-`REL: heracles yyyy.mm` that includes the following changes:
-
-- The changelog trailers since the last release are parsed into the
-  [changelog](CHANGELOG.md) under a section titled `[yyyy.mm]  (DD Mon YYYY)`.
-  A new link to the changeset is added at the bottom of the file.
-- The [release notes](docs/manual/releases.rst) are updated with the new
-  version. The release notes should translate the changelog entries into
-  prose that can be understood by non-developer users of the code. If there
-  are breaking changes, a release note should explain what the changes mean for
-  existing code.
-
-Once these changes are merged into the `main` branch, a new release with title
-`heracles yyyy.mm` should be created in the GitHub repository. The description
-of the release should be a copy of its release note.
-
-Creating the release will automatically start the build process that uploads
-Python packages for the new version to `PyPI`.
+New versions of _Heracles_ are prepared using GitHub releases.
 
-If any _Heracles_ extension packages depend on the new release, new versions of
-these packages should be produced as soon as the new release is published to
-`PyPI`.
+Creating a GitHub release will automatically start the build process that
+uploads Python packages for the new version to `PyPI`.

README.md

@@ -3,7 +3,7 @@
 [![PyPI](https://img.shields.io/pypi/v/heracles)](https://pypi.org/project/heracles)
 [![Python](https://img.shields.io/pypi/pyversions/heracles)](https://www.python.org)
 [![Documentation](https://readthedocs.org/projects/heracles/badge/?version=latest)](https://heracles.readthedocs.io/en/latest/?badge=latest)
-[![Test](https://github.com/heracles-ec/heracles/actions/workflows/test.yml/badge.svg)](https://github.com/heracles-ec/heracles/actions/workflows/test.yml)
+[![Tests](https://github.com/heracles-ec/heracles/actions/workflows/tests.yml/badge.svg)](https://github.com/heracles-ec/heracles/actions/workflows/tests.yml)
 [![Coverage](https://coveralls.io/repos/github/heracles-ec/heracles/badge.svg?branch=main)](https://coveralls.io/github/heracles-ec/heracles?branch=main)
 
 The _Heracles_ code was developed in the _Euclid_ Science Ground Segment.

pyproject.toml

@@ -34,22 +34,27 @@ dynamic = [
 ]
 license = "LGPL-3.0-or-later"
 name = "heracles"
-optional-dependencies = {all = [
+readme = "README.md"
+requires-python = ">=3.9"
+
+[project.optional-dependencies]
+all = [
+    "ducc0",
     "rich",
-], docs = [
+]
+docs = [
     "furo",
     "matplotlib",
     "numpydoc",
     "sphinx",
     "sphinxcontrib-katex",
-], test = [
+]
+test = [
     "ducc0",
     "pytest",
     "pytest-cov",
     "pytest-rerunfailures",
-]}
-readme = "README.md"
-requires-python = ">=3.9"
+]
 
 [project.scripts]
 heracles = "heracles.cli:main"