PlasmaPy / PlasmaPy/plasmapy.github.io
Link to changelogs in docs instead of doing blog posts on each release
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 17
- Fork
- 24
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
It's been pretty common for us me to forget to do the blog posts for the releases. If we have a feature release cadence of ∼3–4 months, we would end up needing to do this pretty often. The blog posts from the releases often repeat information from the changelog. I'm thinking that instead of having blog posts on each release, we should link to the changelog index page such that we won't need to update the webpage with each release.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando i post del blog relativi alle release e la pagina indice del changelog sul sito web. Verifica dove vengono mantenuti i link alle release, quindi aggiorna la pagina pertinente in modo che punti all’indice del changelog invece di richiedere un post del blog per ogni release. Il lavoro è completato quando la documentazione delle release rimanda chiaramente all’indice del changelog e non è necessario un aggiornamento del blog per ogni release.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 38/100