cpprefjp / site

cpprefjpサイトのMarkdownソース
https://cpprefjp.github.io/
375 stars 155 forks source link

「編集しやすい作業」ページを追加 #1104

Closed faithandbrave closed 1 year ago

faithandbrave commented 1 year ago

コントリビュートしやすい作業を、段階的な難易度付きで書いてみました。

項目を足したい、要件をもっと厳しくしたい、危ないから項目自体を一旦なくしたいなど、コメントをいただきながら形にしていきたいです。

faithandbrave commented 1 year ago

ページタイトル、ファイル名 (URL) も、もっといい案があったらください。。。

yohhoy commented 1 year ago

welcome_contribute / 編集しやすい作業 以外のファイル/タイトル案をいくつか並べてみました。

と書いてみたものの、既存の CONTRIBUTING / cpprefjpへのコントリビュート方法 ページとの境界が良く分からなくなってしまいますね。 一部は start_editing / cpprefjpを編集するには とも重複しそうですし、どこかで整理・統合が必要なのかもしれません。

faithandbrave commented 1 year ago

CONTRIBUTINGは「編集方針 (project policy)」のようにして、細かいルールのようなものはstart_editingに移したいところですね。

onihusube commented 1 year ago

とか(柔らかい感じで・・・

faithandbrave commented 1 year ago

「はじめての」だと、むずかしいタスクを書きにくいのですよね。。。

onihusube commented 1 year ago

なるほど、たしかに

faithandbrave commented 1 year ago

書き忘れていた「関連項目を追加する」を追加しました。

faithandbrave commented 1 year ago

むずかしいタスクもあるから、「編集しやすい」も変ですね。。。contribution taskを書きたい場所ではあります。

tshino commented 1 year ago

初めての人には小さめの作業から取りかかってもらうという方針は良いと思いました。 「編集しやすい」よりは「小さめの作業」「取りかかりやすい作業」という感じでしょうか?

初めての人でもスキルや知識はそれぞれだと思うので、難易度別に紹介するのも良い方針だと思いました。

yumetodo commented 1 year ago

もっと広く書きたいという意味なら、「cpprefjpで特に推奨される作業」とかでしょうか・・・

faithandbrave commented 1 year ago

「取りかかりやすい作業」

そういう感じになりますね。

「cpprefjpで特に推奨される作業」

サイドバーに収めないといけないので、「とくに推奨される編集作業」くらいが収まるギリギリですかね…

faithandbrave commented 1 year ago

ファイル名は一旦置いといて、タイトルを先に考えよう。

tomolatoon commented 1 year ago

勧誘ベースとかもいいかもしれません?

faithandbrave commented 1 year ago

start_editing.mdとCONTRIBUTING.mdが重複していたので、整理して、CONTRIBUTING.mdをedit_policy.md (編集方針) にリネームしてサイドバーに表示するようにしました。

faithandbrave commented 1 year ago

start_editing.mdの後ろの方にこのPull Requestの本文を記載して、start_editing.mdのタイトルを「はじめてのコントリビュート」とかのタスクに直結しないタイトルにすることもできるかと思います。 その代わりstart_editing.mdがだいぶ長くなってしまいそうです。

welcome要素をタイトルに入れたいのであればその方がやりやすいとは思いますが、どうでしょうか…。

yumetodo commented 1 year ago

start_editingは長くなっても性質上いいのかなと思っています。

faithandbrave commented 1 year ago

こちら、これ以上はコメントがなさそうなので、以下の対応にしようと思います。