git / git/git.github.io

Update documentation and docstrings in `CONTRIBUTING.md`

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

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

主要言語
CSS
スター
373
フォーク
325
平均マージ
4日 18時間
マージ済み PR(30日)
1

説明

In CONTRIBUTING.md, an issue was identified regarding: Repository lacks a CONTRIBUTING.md guide for open-source collaboration.

  1. Current behavior: The codebase currently exhibits Repository lacks a CONTRIBUTING .
  2. Expected behavior: The code should execute reliably, validate bounds/inputs, and adhere to repository conventions.
  3. Problem justification: Leaving this unaddressed risks unexpected runtime crashes, degraded maintainability, or API contract violations.

cc @sivaraam

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

調査の方向性

まず CONTRIBUTING.md を読み、その内容を、issue で示されているオープンソースコラボレーションガイドの必要性と比較します。不足しているガイダンスと docstring を明確にし、その後ファイルを更新して、リポジトリの規約に沿った完全なコントリビューションワークフローが提供されていることを確認します。

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

評価

技術スタック
markdown
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
活発
明瞭さ
説明が足りない
初心者へのやさしさ
45/100

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

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