Add Contributing.md or other resource for potential contributors

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

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

評価

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

調査の方向性

The issue asks for a contributor guide at the repository root, so the new file is a Markdown document and no code changes. Start by reading the CI configuration and any commit or style checks the repository runs, since the issue says those requirements are undocumented. Then write the guide covering commit message rules, the checks CI enforces, and the code style used for this C project. Done when a newcomer can read the file and pass CI on a first commit without asking.

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

説明

At the moment, there are several checks on commits that are not documented anywhere (?). It would be nice to list these requirements to prevent unnecessary confusion & CI failures.

Additionally, such a document would be a good place to mention code style guidelines (if any), etc.

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

環境構築

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

はじめの一歩

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

openwrt/omcproxy のほかの issue

openwrt/omcproxy の issue をすべて見る

似ている issue

C の issue をもっと見る

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

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