MetaMask / MetaMask/contributor-docs
[contributor-docs] Add guide to creating a GitHub action or workflow
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 86
- Fork
- 42
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
This document should cover best practices that are important to follow in GitHub Actions, such as:
- Providing useful output
- Using secrets for private information (although this could be covered in “Security best practices”)
- Testing GitHub Actions
- Using Shell script vs. JavaScript
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 la struttura della documentazione per i contributori e le eventuali indicazioni esistenti sulle best practice di sicurezza. Aggiungi una guida che tratti l’output utile, i secret, il testing di GitHub Actions e la scelta tra script shell e JavaScript; il lavoro è completo quando ogni argomento richiesto include best practice pratiche e la guida si integra con lo stile della documentazione del repository.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github-actions, javascript, shell
- Ambito
- ci-cd, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 58/100