jamulussoftware / jamulussoftware/jamulus

Docs: Add guidance for CHANGELOG entries

Aperta
#2,788 8 commenti 0 reazioni 0 assegnatari Vedi su GitHub
refactoring
Lingua principale
C
Stelle
1.1k
Fork
248
Merge medio
2g 3h
PR unite (30g)
9

Descrizione

**What is the current behaviour and why should it be changed?**

We currently don't have clear guidance when to add changelog entries.

**Describe possible approaches**

- [ ] What's the goal for the CHANGELOG, who is the audience?
- [ ] Should internal changes (i.e. those which do not directly affect generated artifacts) be documented in the CHANGELOG? Options:
1. Document all PRs.
2. Document PRs which *may* be user-visible (i.e. including third-party library bumps, build logic changes)
3. Document PRs which intended user-visible changes only (bug fixes, new features, performance changes).
- [ ] How should entries be written? (past tense)
- [ ] How are related PRs handled?
- [ ] Where should this guidance be stored? PR template?

**Has this feature been discussed and generally agreed?**

One of the previous discussions around this topic: https://github.com/jamulussoftware/jamulus/pull/2778#issuecomment-1213473371

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo CONTRIBUTING.md e la discussione collegata da PR #2778. Risolvi le questioni aperte relative al pubblico del CHANGELOG, a quali modifiche richiedono voci, allo stile delle voci, alle PR correlate e a dove debbano essere inserite le indicazioni. Il lavoro è completato quando il progetto dispone di indicazioni concordate e attuabili nella posizione selezionata.

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

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Tranquilla
Chiarezza
Da chiarire
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.