ComputerScienceHouse / ComputerScienceHouse/swag

Better README

Offen
#12 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
HTML
Sterne
2
Forks
2
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

As the beginning of the year approaches, freshman will soon try to look at and contribute to CSH projects. It's a bit hard when there are no setup instructions, or links of where to download python, pip, or any other tools we use.
It would be a good idea to add to the README some setup and other useful information

- [ ] Setup information
- [ ] System Dependencies
- [ ] Python version, potentially as a badge [![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
- [ ] Code standards (Less important if pylint is present)

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne mit der Durchsicht der vorhandenen README und der Einrichtungsanforderungen des Projekts. Dokumentiere die Einrichtungsschritte, Systemabhängigkeiten, Informationen zu Python und pip, gegebenenfalls ein Badge für die Python-Version sowie Codestandards; abgeschlossen bedeutet, dass jeder Checklistenpunkt mit den erforderlichen nützlichen Links abgedeckt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
developer-experience, documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
Ein halber Tag
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.