ericclemmons / ericclemmons/polydev
Update README to emphasize onboading
- Vorherrschende Sprache
- JavaScript
- Sterne
- 282
- Forks
- 6
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Interesting Zero (https://github.com/remoteinterview/zero) got traction for the ease to start, which is something Polydev does well (but designed to support both existing apps as well as grow into complex apps).
I think it'd be better to emphasize several recipes & examples. Let the simplicity speak for it, instead of explaining "rationale" specific to the pain-points non-trivial projects have.
For instance, file-based routing is useful, but it isn't until you want to have a `.test.js` file or `middleware.js` does the decision to have an explicit whitelist of entry-points make sense under `/routes` instead of allowing ad-hoc files.
Beitragsleitfaden
Rechercherichtung
Beginne mit der README und prüfe, wie sie derzeit Polydevs Begründung, dateibasierte Weiterleitung und die Whitelist der Einstiegspunkte erklärt. Überarbeite den Schwerpunkt der Einführung hin zu konkreten Rezepten und Beispielen und berücksichtige die in der Issue beschriebenen Fälle .test.js und middleware.js. Als erledigt gilt die Aufgabe, wenn ein Neuling den einfachen Einstiegspfad verstehen kann, ohne die Erklärung darüber zu verlieren, wie dieser Ansatz komplexe Apps unterstützt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, node.js
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 38/100