Tirenvi_02/32.zenn_awesome
をテンプレートにして作成
[
Front page
] [
New
|
Page list
|
Search
|
Recent changes
|
Help
]
Start:
* Zenn + awesome list (neovim) [#f5589970]
# 初めてawesome listにPRを出して通った話
## はじめに
Neovimの自作プラグインをGitHubでOSS公開しました。
ZennとRedditで告知したので、次は「awesome list掲載」を目...
結果、無事に掲載されたので、その流れとハマりどころをまと...
これから挑戦する方の参考になれば嬉しいです。
---
## awesome listとは
awesome listは、特定分野の良質なツールをまとめたキュレー...
Neovimには「awesome-neovim」があり、ここに掲載されると：
* 信頼性が上がる [#cdbe75d3]
* 継続的な流入が期待できる [#j45dc71f]
* 他サイトにも拾われやすくなる [#w8afbb50]
といったメリットがあります。
---
## やったこと（全体の流れ）
1. Contribution Guidelinesを読む
2. forkしてREADMEに1行追加
3. PR作成
4. CIエラー対応
5. Suggested change対応
6. マージ
---
## PR作成まで
リポジトリをforkして、README.mdに自分のプラグインを追加し...
ここで少し悩んだのが「どのセクションに入れるか」でした。
* Editing Support [#k97a2dac]
* Markdown and LaTeX [#w98e909a]
* CSV files [#tcd6f8ef]
などが候補でしたが、
> 一番ユーザーが探しそうな場所
という観点で「Markdown and LaTeX」に入れました。
---
## CIで落ちる（ここが一番のハマりどころ）
最初のPRはCIで落ちました。
原因は、説明文に `&` を使っていたことです。
```text
Structural Markdown & CSV table editor with lossless roun...
```
awesomeのルールでは `&` は使わず、`and` にする必要があり...
```text
Structural Markdown and CSV table editor with lossless ro...
```
こういったフォーマットの違いでCIが落ちるので注意が必要で...
---
## Suggested changeが来る
レビューで次のような修正提案が来ました：
```diff
- Structural Markdown and CSV table editor with lossless ...
+ Edit Markdown and CSV tables with lossless round-trip.
```
ポイントは：
* 抽象的な表現（Structural）を削る [#u6e064a0]
* 動詞（Edit）で始める [#g7a5aebf]
👉 そのまま「Commit suggestion」を押して反映しました
---
## マージ
修正後、CIが通り、そのままマージされました。
特に追加のやり取りはなく、比較的スムーズでした。
---
## やってみて分かったこと
### �� シンプルが通る
説明は短く・具体的な方が通りやすいです。
---
### �� フォーマットで落ちる
内容よりも：
* 記号（& など） [#y38b8a6a]
* ピリオド [#w605e2f2]
* 空白 [#o2f53146]
でCIが落ちることがあります。
---
### �� Suggested changeには従う
メンテナのスタイルに合わせるのが一番早いです。
---
### �� カテゴリ選びが重要
どこに置くかで見られ方が変わります。
---
## マージ後
* GitHub starsが少し増加 [#g033dff4]
* 信頼性が上がった感触 [#w25b1c33]
* 他サイトに載る可能性が出てきた [#hf8db090]
※即バズるわけではなく「じわじわ効く」タイプです
---
## まとめ
awesome listへの掲載は、
* 難易度はそこまで高くない [#afbdd166]
* ただしルールは厳密 [#tdb4d4c2]
* 小さな差分でCIに落ちる [#x8d535e7]
という印象でした。
---
## おわりに
初めてのPRでしたが、思ったよりスムーズに進みました。
* 自作プラグインを広めたい [#p570267a]
* 信頼性を上げたい [#ca4a7c96]
と考えている方にはおすすめです。
もし参考になれば嬉しいです。
End:
* Zenn + awesome list (neovim) [#f5589970]
# 初めてawesome listにPRを出して通った話
## はじめに
Neovimの自作プラグインをGitHubでOSS公開しました。
ZennとRedditで告知したので、次は「awesome list掲載」を目...
結果、無事に掲載されたので、その流れとハマりどころをまと...
これから挑戦する方の参考になれば嬉しいです。
---
## awesome listとは
awesome listは、特定分野の良質なツールをまとめたキュレー...
Neovimには「awesome-neovim」があり、ここに掲載されると：
* 信頼性が上がる [#cdbe75d3]
* 継続的な流入が期待できる [#j45dc71f]
* 他サイトにも拾われやすくなる [#w8afbb50]
といったメリットがあります。
---
## やったこと（全体の流れ）
1. Contribution Guidelinesを読む
2. forkしてREADMEに1行追加
3. PR作成
4. CIエラー対応
5. Suggested change対応
6. マージ
---
## PR作成まで
リポジトリをforkして、README.mdに自分のプラグインを追加し...
ここで少し悩んだのが「どのセクションに入れるか」でした。
* Editing Support [#k97a2dac]
* Markdown and LaTeX [#w98e909a]
* CSV files [#tcd6f8ef]
などが候補でしたが、
> 一番ユーザーが探しそうな場所
という観点で「Markdown and LaTeX」に入れました。
---
## CIで落ちる（ここが一番のハマりどころ）
最初のPRはCIで落ちました。
原因は、説明文に `&` を使っていたことです。
```text
Structural Markdown & CSV table editor with lossless roun...
```
awesomeのルールでは `&` は使わず、`and` にする必要があり...
```text
Structural Markdown and CSV table editor with lossless ro...
```
こういったフォーマットの違いでCIが落ちるので注意が必要で...
---
## Suggested changeが来る
レビューで次のような修正提案が来ました：
```diff
- Structural Markdown and CSV table editor with lossless ...
+ Edit Markdown and CSV tables with lossless round-trip.
```
ポイントは：
* 抽象的な表現（Structural）を削る [#u6e064a0]
* 動詞（Edit）で始める [#g7a5aebf]
👉 そのまま「Commit suggestion」を押して反映しました
---
## マージ
修正後、CIが通り、そのままマージされました。
特に追加のやり取りはなく、比較的スムーズでした。
---
## やってみて分かったこと
### �� シンプルが通る
説明は短く・具体的な方が通りやすいです。
---
### �� フォーマットで落ちる
内容よりも：
* 記号（& など） [#y38b8a6a]
* ピリオド [#w605e2f2]
* 空白 [#o2f53146]
でCIが落ちることがあります。
---
### �� Suggested changeには従う
メンテナのスタイルに合わせるのが一番早いです。
---
### �� カテゴリ選びが重要
どこに置くかで見られ方が変わります。
---
## マージ後
* GitHub starsが少し増加 [#g033dff4]
* 信頼性が上がった感触 [#w25b1c33]
* 他サイトに載る可能性が出てきた [#hf8db090]
※即バズるわけではなく「じわじわ効く」タイプです
---
## まとめ
awesome listへの掲載は、
* 難易度はそこまで高くない [#afbdd166]
* ただしルールは厳密 [#tdb4d4c2]
* 小さな差分でCIに落ちる [#x8d535e7]
という印象でした。
---
## おわりに
初めてのPRでしたが、思ったよりスムーズに進みました。
* 自作プラグインを広めたい [#p570267a]
* 信頼性を上げたい [#ca4a7c96]
と考えている方にはおすすめです。
もし参考になれば嬉しいです。
Page:
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
