README を刷新して開発を始めるための情報を書く#220
Merged
Merged
Conversation
- README を README.md にして、概要・ドキュメントへの導線・開発セットアップ・ テスト実行・型検査・doctree と組み合わせた動作確認の手順を記載 - 廃止予定の wiki への参照を doc/usage.md と doctree の docs/ に差し替え (gemspec の documentation_uri / wiki_uri も同様) - 用語集は旧 README から引き継ぎ Fixes rurema#23 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
解決したい問題
Fixes #23
README が32行の概要のみで、新しく開発に参加する人が何をすればよいか分からない
状態でした。また、本文と gemspec が廃止予定の GitHub wiki を参照していました
(wiki の内容は 2026-07 に doctree の
docs/と bitclust のdoc/usage.mdへ移行済み)。変更内容
README→README.mdにリネームし、以下を記載doc/usage.md、doctree のdocs/)bundle install)・テスト実行(rake test/ 単一ファイル)・型検査(rake sig/steep check)BITCLUST_PATHによるローカル参照、rake generate/statichtml)bitclust-core.gemspecfilesのREADMEをREADME.mdに更新documentation_uriを wiki からdoc/usage.mdに変更、wiki_uriを削除🤖 Generated with Claude Code