Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
#27 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
jupyter-notebook, python

調査の方向性

まず、要求されている生成ファイルを確認します: setup.py、conf.py、MANIFEST.in、README.md、requirements.txt、license.txt、api.rst、index.rst、tutorials.rst、およびサンプル notebook。スクリプトが不足しているファイルをどのように検出するか、また setup.py の値がそれらにどのように影響するかを定義します。完了条件は、不足している package、test、example、documentation のファイルが生成され、要求された GitHub、Travis、Read the Docs、release、fork、pip の手順が to-do リストとして出力されることです。

索引モデルが issue の本文から書いたものです。

説明

  • 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
主要言語
Jupyter Notebook
スター
17
フォーク
4
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ContextLab/CDL-tutorials のほかの issue

ContextLab/CDL-tutorials の issue をすべて見る

似ている issue

Build System の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。