sinonjs/sinon

Add breaking changes to GitHub release notes

Aperta

#2268 aperta il 15 giu 2020

Vedi su GitHubGuida contributor
 (9 commenti) (0 reazioni) (0 assegnatari)JavaScript (764 fork)batch import
Help wantedhacktoberfestpinned

Metriche repository

Star
 (9548 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The release notes on GitHub are currently empty. It would be beneficial if these contained the breaking changes for each major release. Currently these are only showing in the github repo.

This is about hooking into the release scripts and pushing the changes to the Github releases using the Github API. Start by investigating how the release script works by looking at the scripts in package.json and then how to extract the relevant parts from the changelog markdown file. The github API is quite easy to grok.

Guida contributor

Direzione di ricerca
Leggi gli script di rilascio in package.json per comprendere il flusso di lavoro di rilascio. Quindi, capire come analizzare il file markdown del changelog per estrarre le modifiche che rompono la compatibilità. Infine, usa l'API di GitHub per aggiornare le note di rilascio.
Tech stack
javascript
Dominio
releasetooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitNode.js
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60