Orgs please make Contributor Guidelines pages more clear for potential contributors
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
調査の方向性
まず、ウェブサイトのContributor Guidanceページと、issueに記載されているガイダンスの例へのリンクを確認します。各ページで最初の連絡手順が説明され、コミュニティまたはメンターへの明確なリンクが提供され、日付が最新であるかを監査します。完了とは、ガイダンスが明確で、歓迎する内容であり、最新の状態であることを意味します。
索引モデルが issue の本文から書いたものです。
説明
We are past the stage in which this is relevant for GSoC '22 but let's make sure we address it early for '23.
I was doing a quick look through the Contributor Guidance sections of about 30 orgs and quickly noticed that it isn't clear what the contributor should do first for about 80% of them. Many of you are still tweaking these during this first week and that is fine but we have really been trying to push interested contributors to reach out to you now (rather than waiting until apps open April 4) so you can expect to get many folks coming to your page and wanting to talk to you over these next few weeks. Having the information as accessible as possible as soon as possible is very important.
Some of the issues I have seen with the Contributor Guidelines links:
- An Org has information in there but you don't explicitly say reach out to us via our chat channel, xyz or whatever that first contact should be.
- Org has a link to their forum but there are 4 or 5 different lists for the contributors to choose from on your page. It isn't clear to someone coming in to your org for the first time which of those they should choose.
- Saying talk to the mentor about the project idea but not giving information on how/where they would do that (some orgs have the mentor contact details on the project ideas page so it's more obvious but many do not so I am guessing you want them to reach out via a chat channel or forum but you don't say that).
- Linking to your project ideas where there is no additional information on what to do, just the list of Ideas isn't actual guidance.
- Having wrong info on your page (2021 dates, etc.) There were some that had great info but the pages haven't been updated with the 2022 info so I couldn't list them as the great examples that they were otherwise.
- If you are going to list the student application dates on your pages (which is helpful to do) be sure the dates are correct (should be April 4-19 1800 UTC for 2022).
A few good examples that make it clear what a GSoC contributor should do first with your org:
ArduPilot
GNOME
Performance Co-Pilot
RoboComp
Wikimedia Foundation
Remember you want to make reaching out to your community as easy and welcoming as possible for interested contributors.
- 主要言語
- JavaScript
- スター
- 6
- フォーク
- 39
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
CCExtractor/website のほかの issue
-
Broken Qualification Task Link (Taskserver 3)対応中かも @Aniket01 が 202 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
CCExtractor/website#117 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
CCExtractor/website#116 · コメント 1 件 ·
-
Improve README.md for Better Setup and Contribution Guide再び着手できるかも @Monika-200677S が 285 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
CCExtractor/website#67 · コメント 3 件 ·
-
Add cross-reference link between GSoC 2025 ideas and classics pages再び着手できるかも @Monika-200677S が 284 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 55/100
CCExtractor/website#65 · コメント 2 件 ·
-
Feature: Adding Download on Menu list再び着手できるかも @SahilAhd が 321 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
CCExtractor/website#46 · コメント 3 件 ·
CCExtractor/website の issue をすべて見る
似ている issue
-
documentation good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
bug release:v5.56
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Jason-Vaughan/TangleClaw#2270 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
style-dictionary/style-dictionary#1773 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
SignalK/signalk-server#3143 ·
メンテナーはふだん 1 日以内に返信