code-corps / code-corps/code-corps-ember
Write documentation for the Github integration flow
- Vorherrschende Sprache
- JavaScript
- Sterne
- 120
- Forks
- 75
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
# Problem
We need big picture "how it works" documentation for github integration flow and what it does.
A big chunk of it is explained in #1331 and some of it is additionally explained in #1370
However, it needs to be written in an easier to digest format for developers to refer to when working on integration features.
Beitragsleitfaden
Rechercherichtung
Beginne mit dem Lesen der Issues #1331 und #1370, die die bestehenden Erklärungen zum GitHub integration flow enthalten. Mache aus diesem Material eine leichter verständliche Entwicklerreferenz, die abdeckt, wie der flow funktioniert und was er tut. Die Aufgabe ist erledigt, wenn das Verhalten der Integration so klar dokumentiert ist, dass Entwickler, die an Integrationsfunktionen arbeiten, damit arbeiten können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github, javascript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100