Allow direct branches and pull requests from BBC staff

Aperta
  • Qualcosa non va?
#170 0 commenti 1 reazione 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
git, github
Ambito
devops, documentation

Direzione di ricerca

Inizia esaminando il processo attuale per i contributi del repository e le impostazioni di GitHub per la protezione dei branch e CODEOWNERS. Definisci il file CODEOWNERS richiesto, le regole di protezione dei branch e la documentazione per i contributors descritti nell’issue; il lavoro è completato quando i membri dell’organizzazione BBC possono aprire pull request dirette, mentre i merge richiedono ancora le approvazioni specificate, e i contributors esterni possono continuare a usare i fork.

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

Descrizione

The GEL technical guides are pieces of documentation that detail recommended, accessible implementation approaches for GEL components. When GEL patterns are updated, either through UX or engineering, the GEL technical docs should also be updated to reflect the changes.

Currently, as this is a public repository, it is necessary for those without write access to fork the repo in order to raise a pull request to update the docs. My understanding of the reasoning here is that it limits the ability to merge and update the public-facing documentation to a select group of administrators. This is to mitigate the risks associated with having public-facing documentation that anyone can access.

However, this method can increase the perceived barriers for folks who would like to contribute to the documentation from within the BBC, especially when contributions to this repo are on a volunteer basis.

Therefore, I propose that we change the way that contributions work by enacting the following:

  • Allow everyone within the bbc github organisation write access to the repository.
  • Create a new CODEOWNERS file for the repo that limits ownership to repo administrators.
  • Create a new branch protection rule that:
    • Requires a pull request from a branch
    • Requires at least 1 approval before merge
    • Enforces at least 1 review to be from a Code Owner for the repo.
  • Document the above process in a contributors doc.

Using branch protection rules and CODEOWNERS in this way allows us to continue mitigating the public-facing risk by limiting the ability to merge changes to being approved by a particular group (likely the current admins). However, it will then be possible for anyone within the BBC github organisation to branch from the main repo and create a pull request without having to fork the entire repo.

Contributors from outside of the BBC github org will continue having to fork the repo to raise a pull request.

Lingua principale
JavaScript
Stelle
50
Fork
19
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 bbc/gel

Tutte le issue di bbc/gel

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.