Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

add script to generate all non-code files automatically if they don't exist

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
jupyter-notebook, python

Direzione di ricerca

Inizia esaminando i file generati richiesti: setup.py, conf.py, MANIFEST.in, README.md, requirements.txt, license.txt, api.rst, index.rst, tutorials.rst e il notebook di esempio. Definisci come lo script deve rilevare i file mancanti e in che modo i valori di setup.py li influenzano. Il lavoro è completato quando vengono generati i file mancanti del package, dei test, degli esempi e della documentazione e i passaggi richiesti per GitHub, Travis, Read the Docs, la release, il fork e pip vengono restituiti come elenco di attività da svolgere.

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

Descrizione

  • setup.py (use folder name as name of project, and if any of the below are specified, change the script accordingly to reference them)

other info could be read from setup.py

  • conf.py
  • MANIFEST.in
  • README.md
  • requirements.txt
  • license.txt
  • basic test (so pytest can run)
  • basic example (so sphinx compiles)
  • api.rst
  • index.rst
  • tutorials.rst
  • sample tutorial notebook

then output a "to do" list of how to:

  • set up github web hooks for slack
  • get travis configured
  • compile sphinx web page
  • register on readthedocs and publish readthedocs page
  • do a github release
  • set up forks on github for development (once package is "live," rather than modifying master branch directly)
  • push to pip (after package is ready for release)
  • install package from pip
Lingua principale
Jupyter Notebook
Stelle
17
Fork
4
Metriche di merge delle PR
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 ContextLab/CDL-tutorials

Tutte le issue di ContextLab/CDL-tutorials

Issue simili

Altre issue su Build System

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.