automatic-copyright-year: keep README copyright current

Ouverte
#189 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@anshulchikhale30-p y travaille déjà.

Depuis le 15/11/2026.

  • #190 par @anshulchikhale30-p — ouverte

Évaluation

Difficulté
3/5
Temps estimé
Une demi-journée
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
Active
Stack technique
github-actions, python
Domaine
ci-cd, documentation

Piste de recherche

Start by reading pull request #190, which is already open against this issue, and the footer line in README.md. Then look at the existing workflows under .github/workflows/ to match conventions, and write a scheduled plus workflow_dispatch job with contents: write that rewrites only the copyright line and checks git diff before committing. Done means a manual run on 2026 produces © 2025-2026 The Stable Order., a second run makes no commit, and the chosen push-vs-PR path is settled against branch protection.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

documentation enhancement

Summary

The README footer hardcodes the copyright year:

© 2025 The Stable Order.

It should automatically show the current year range. For 2026:

© 2025-2026 The Stable Order.

and on January 1, 2027 it should become:

© 2025-2027 The Stable Order.

without a manual edit.

Proposed behavior

  • Start year stays 2025.
  • End year is the current UTC year.
  • If the current year is 2025, render © 2025 The Stable Order.
  • If the current year is later, render © 2025-<current-year> The Stable Order.
  • The update must be idempotent: if the line already matches, make no commit.

Suggested implementation

Add a small scheduled GitHub Actions workflow, for example:

  • on.schedule with a January 1 cron, plus workflow_dispatch for testing.
  • permissions: contents: write.
  • A short Python or shell step that updates only the copyright line in README.md.
  • Commit only when the value changed.

If main is protected, the workflow can open a PR instead of pushing directly. That can be decided during implementation.

Scope

  • Only the README copyright line.
  • No license text changes.
  • No unrelated README edits.
  • No PR yet; this issue is for discussion and approval first.

Acceptance criteria

  • README shows © 2025-2026 The Stable Order. for 2026.
  • On January 1, 2027 it updates to © 2025-2027 The Stable Order. automatically.
  • Re-running the workflow in the same year makes no change and no empty commit.
  • The workflow can be run manually for testing.
  • Only the copyright line is modified.
  • The chosen approach works with the repository's branch protection rules.

Open question

Should the workflow commit directly to main, or open a PR for review each year?

Langage dominant
Python
Étoiles
12
Forks
27
Merge moyen
2 min
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de StabilityNexus/MiniChain

Toutes les issues de StabilityNexus/MiniChain

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.