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

Update ReadMe

オープン 初心者向け
  • 何か問題がありますか？
#444 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
78/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
mysql, python
領域
documentation

調査の方向性

まず README.md と requirements.txt、app/dbConfig.yaml、app/models/models.py、create_db.py、app.py を読み、提案されたセットアップ手順がプロジェクトに合っているか確認します。Python 3.11、MySQL、データベースの初期化、アプリの実行を含め、macOS と Windows 向けの前提条件とセットアップ手順を書き直します。初めて貢献する人が README に従ってどちらの OS でもアプリを起動でき、古い記述がなくなれば完了です。

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

説明

The current README.md is significantly outdated and references legacy tools, EOL software versions, and deprecated cloud environments (such as Python 2.7). New contributors cannot successfully set up the project using the existing documentation.
Currently fails to run source setup.sh and create_db.py.

Proposed Action Items

  • Rewrite Prerequisites:
  • Update required Python version to Python 3.10+
  • Modernize Installation & Setup:
    • Update dependency installation steps (e.g., pip install -r requirements.txt ).
    • Clarify database initialization (create_db.py).

Additional details

The README needs to work for both macOS and Windows contributors.

What is wrong with the current README
  • Says Python 2.7 is required. The app is Python 3.
  • Tells people to clone from Bitbucket and mentions Cloud9. The repo is on GitHub.
  • Says to run source setup.sh. It also creates the venv with whatever python3 is newest on the machine.
  • Never mentions that MySQL is required. The app connects to a MySQL database (see app/dbConfig.yaml and app/models/models.py).
  • Says to use https:// to open the app. app.py does not set up SSL, so it is http://localhost:8080.
  • Refers to files and folders that no longer match the repo (for example the "File Hierarchy" section).
Known setup problems to document
  • Python version: On Python 3.14, pip install -r requirements.txt fails while building greenlet==1.1.0. The pinned packages in requirements.txt are from 2021, so the README should name a specific supported version (for example 3.11) rather than "3.10+" and warn against newer ones. Better still, update the greenlet pin in requirements.txt so the install works on newer Python.
  • MySQL setup: The app expects a database cas and a user cas_user with the password password (from app/dbConfig.yaml). The README should give the SQL to create them: 
    CREATE DATABASE IF NOT EXISTS cas;
CREATE USER IF NOT EXISTS 'cas_user'@'localhost' IDENTIFIED BY 'password';
GRANT ALL ON cas.* TO 'cas_user'@'localhost';
What the new README should contain
  1. Prerequisites: Git, Python 3.11, MySQL (with a note on how to check the MySQL server is running on each OS).
  2. Get the code: git clone https://github.com/BCStudentSoftwareDevTeam/cas.git
  3. Create the virtual environment and install packages, with separate commands for each OS:
    • macOS: python3.11 -m venv venv then source venv/bin/activate
    • Windows (PowerShell): py -3.11 -m venv venv then venv\Scripts\Activate.ps1
  4. Create the MySQL database and user (the SQL above).
  5. Create the tables and sample data: mkdir data then python create_db.py.
  6. Run the app: python app.py, then open http://localhost:8080.
  7. Returning later: activate the venv and run python app.py.
  8. Troubleshooting, for example:
    • "Can't connect to MySQL server": the MySQL service is not running or is on a different port.
    • "Access denied for user 'cas_user'": redo the database user step.
    • pip fails building a package: check python --version is the supported version.
    • "Address already in use": another program is using port 8080.
Acceptance criteria
  • Someone with a fresh macOS or Windows machine can go from clone to a running app using only the README.
  • The README no longer mentions Python 2.7, Bitbucket or Cloud9.
  • setup.sh is either removed from the instructions or replaced by steps that work on Windows.
主要言語
JavaScript
スター
0
フォーク
2
30日以内にマージされた PR はありません

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

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

BCStudentSoftwareDevTeam/cas のほかの issue

BCStudentSoftwareDevTeam/cas の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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