docs(contributing): add a deprecation and removal process for public API

Aperta
#309 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@ffumero2003 ci sta già lavorando.

Dal 8/11/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

documentation

Context

blazer has changelog kinds Deprecated/Removed and one // Deprecated: marker (b2/b2.go), but no written process for retiring public API, so timing and warning are inconsistent.

Acceptance criteria

  • R1. CONTRIBUTING.md documents the deprecate → replace → remove steps and the window.

In scope

Add a short section to CONTRIBUTING.md: mark // Deprecated: use X, ship the replacement (and an example), keep the old symbol for a stated number of releases, then remove it with a **Breaking:** changelog entry. Decide the support window for a pre-1.0 module.

Out of scope

  • Unrelated work outside the components and behavior described in In scope.

Verification

git diff --check
  • Review the documented deprecate → replace → remove sequence against the acceptance criterion and existing changelog conventions.
  • The pre-1.0 support window is an open decision in this issue; record that decision rather than assuming a number of releases.
  • Expected result: the checks above succeed and the observable outcomes in Acceptance criteria are demonstrated. If a check cannot run, report Could not run because: ...; if it starts but fails, report Could not complete because: .... A skipped check is not a pass.

Links

Pairs with the API-change gate (the API-compat CI issue).

Lingua principale
Go
Stelle
66
Fork
18
Merge medio
1g 10h
PR unite (30g)
132

Preparare l'ambiente

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.

Altre issue di Backblaze/blazer

Tutte le issue di Backblaze/blazer

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.