ringcentral / ringcentral/ringcentral-python

Complete optional Python project modernization

Aperta
#114 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Python
Stelle
56
Fork
40
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Motivation

After the compatibility, reproducibility, CI, and documentation bugs are fixed, several optional modernization opportunities will remain. They can improve maintainability and release security, but they are not required to restore currently promised behavior and should not be mixed into the bug fixes.

Candidate scope

  • Evaluate retaining, upgrading, replacing, or removing observable; version 1.x changes behavior used by the SDK and is a compatibility migration rather than a routine version bump.
  • Upgrade websockets, documentation, development, coverage, and build dependencies with focused compatibility checks.
  • Upgrade GitHub Actions and choose an explicit third-party action pinning policy.
  • Upgrade or replace the GitHub Pages deployment action.
  • Remove superseded setup.py, setup.cfg, MANIFEST.in, and requirements files only after artifact and workflow parity is established.
  • Reconsider whether tests should ship in distributions and whether demos should be included, without silently changing artifact contents.
  • Add useful optional project metadata.
  • Evaluate PyPI Trusted Publishing and uv publish while preserving or explicitly redesigning tag-driven version and release behavior.
  • Consider optional credentialed live compatibility smoke tests outside deterministic unit CI.

Acceptance criteria

  • Each proposed dependency or tooling upgrade has a documented compatibility reason and focused verification.
  • Observable compatibility is resolved deliberately rather than treated as an automatic version bump.
  • Any packaging-file or artifact-content cleanup occurs only after parity is demonstrated and the intended change is explicit.
  • Any release-authentication or publishing change has a non-uploading dry run and documented rollback path.
  • Deterministic unit CI remains independent of live credentials.
  • The enhancement is split into independently deliverable child tickets before implementation begins.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Start by reading issue 114 and inventory setup.py, setup.cfg, MANIFEST.in, requirements files, GitHub Actions workflows, and release configuration. Split the modernization candidates into independently deliverable child tickets before implementation. Done requires focused compatibility checks, artifact parity where relevant, non-uploading publishing verification, rollback documentation, and deterministic CI without live credentials.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github-actions, python
Ambito
build-system, ci-cd, developer-experience, release, security
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Attiva
Chiarezza
Da chiarire
Idoneità per principianti
20/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.