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

improve user-friendliness of README file

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

READMEから始め、目次にあるUser guideリンクを確認し、特にsmuggle文とそのBNF文法に関するセクションを調べてください。ドキュメントを再構成し、クイックスタートとUser guideでは一般的な機能に焦点を当て、技術的な資料は別のページに移します。READMEが新しいユーザーにとって分かりやすく、技術リファレンスの内容を削除していないことを完了の条件とします。

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

説明

documentation enhancement good first issue help wanted

Good suggestion from one of our SoftwareX reviewers:

Currently, the README has a mix of user-friendly information and technical information, and the technical information may be intimidating to new users. This problem can be easily avoided by having a quick start section in the README and a user guide page that are focused only on the features that most users will need and moving the technical information to a separate page or pages.

For example, currently the "User guide" link in the TOC goes to a section on the smuggle statement, which starts with the grammar definition using BNF notation. Most users will have no idea what those symbols mean, so the BNF won't be very helpful for most users and may be intimidating to people who aren't serious Python developers.

主要言語
TeX
スター
37
フォーク
8
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

ContextLab/davos のほかの issue

ContextLab/davos の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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