Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Guard semantic versioning for major changes using binary compat checks in .fsproj

Aperta
  • Qualcosa non va?
#194 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
fsharp
Ambito
build-system

Direzione di ricerca

Inizia esaminando la configurazione .fsproj del repository e la PR #167 per comprendere le modifiche all'API pubblica relative a cancellationToken. Confronta i controlli di compatibilità binaria disponibili con il controllo di versionamento semantico richiesto; il lavoro è completato quando le violazioni importanti dell'API pubblica vengono rilevate o impedite durante il workflow del progetto.

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

Descrizione

breaking change enhancement

I couldn't find this documented, not in a release-notes, and not in the PR where it happened (#167). Several functions were updated with extra arguments (namely: cancellationToken) that cause existing code to break at compile time (in my source code in 100+ places, it's a non-trivial effort to fix):

image

I understand the need to update public functions, but introducing backwards compatibility should be done with the biggest restraints, and prevented if at all possible. My suggestion would be to link to an update page where the changes are highlighted, or first have a version that marks functions as obsolete (ObsoleteAttribute), which you can use to explain users what to use instead, going forward.

I know, it is OSS and I shouldn't be too fuzzy about all of this, we're all volunteers out here :). In fact, I'm currently in a similar situation with F#'s TaskSeq (see: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/179, https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/167 and https://github.com/fsprojects/FSharp.Control.TaskSeq/discussions/188). Meaning, I need to support cancellation tokens but ideally without introducing backward compat issues.

Rants aside, I really appreciate this library, it has made our lives a lot easier!!! ❤️

Lingua principale
F#
Stelle
498
Fork
41
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 fsprojects/FsHttp

Tutte le issue di fsprojects/FsHttp

Issue simili

Altre issue su Build System

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.