Better README

Aperta
#4 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
42/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Aggiorna il README del repository con le istruzioni per la configurazione, le dipendenze di sistema, i link per il download di Python, pip e altri strumenti, la versione di Python o un badge e, se applicabile, gli standard del codice. Esamina prima il README esistente e usa la checklist per confermare che le informazioni richieste siano presenti e comprensibili per i nuovi contributori.

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

Descrizione

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
  • Code standards (Less important if pylint is present)
Lingua principale
Python
Stelle
5
Fork
3
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 ComputerScienceHouse/self-service

Tutte le issue di ComputerScienceHouse/self-service

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.