Issueから始めるOSS活動

2022/10/28 プロ研第5回LT会 発表資料

Transcript

1. Issueから始めるOSS活動 2022/10/28 プロ研LT会
2. 自己紹介 小野山翔大 / o-xian • 九州工業大学 工学部 宇宙システム工学科 4年 • この前手術しました
3. こんな経験ありますか？ 発信した情報が 多くの人を助けた
4. こんな経験ありますか？ 僕はこの前ありました
5. きっかけ • 個人ブログを作っていた時に、zenn-embedded-elementsを使いたくなった • zenn-embedded-elements • マークダウンファイルをZennのHTML形式に変換してくれるライブラリ
6. CSSが効かない… •GitHubのREADMEやZennの記事を見ても、 CSSが適用されない😭
7. GitHubにIssueを立てた • README通りに動かないのはバグではないか? • GitHubのIssueで質問した
8. ライブラリの作者さまから反応が • 1日経たないうちに、作者のcatnoseさんから返信があった • catnoseさんありがとうございます…🙏
9. 無事動きました • 指定されたバージョンをインストールしたら動いた😆
10. 久々にIssueを見てみる • 今月、GitHubモバイルアプリの方に通知が来たので、 数ヶ月ぶりにIssueを確認 • 結構スタンプが付いてたり、PullRequestでメンションされてたり
11. Issueがめっちゃ参照されてた • ふと気になってzenn-embeded-elementをググる • Zennの記事や個人ブログで、 私の出したIssueが参考資料として貼られていた
12. みんな困ってた • 自分がぶち当たった不具合は、 他の人の環境でも再現されればバグになる • 見つけた不具合が未報告なら、開発者に報告すべき • なんなら、自分で不具合を直してプルリクを出せるとヨシ (いわゆるOSS活動)
13. PullRequestを出すべきだった • Issueの質問だけで終わらせず、 READMEなどを編集してPullRequestを出すべきだった • 同じ問題にぶち当たった人がIssueを探す必要がなくなる 【本音】ZennのContributerになれたかも…
14. まとめ まずは外部へ発信しよう あなたの情報が 誰かの力になるかもしれません
15. 参考資料 • zenn-embed-elementsが導入できない · Issue #293 · zenn-dev/zenn- editor • https://github.com/zenn-dev/zenn-editor/issues/293 • zenn-embed-elements – npm • https://www.npmjs.com/package/zenn-embed-elements • Zennの2種類の執筆方法について • https://zenn.dev/zenn/articles/editor-guide
16. 参考資料 • package.jsonのバージョン表記では「^0.1.106」と「0.1.106」は意味が違うことがある | oshanqq dev • https://www.oshanqq.dev/posts/json-version • エンジニアなら自分でブログを作れ！③Markdownのカスタマイズ編 • https://zenn.dev/miketako3/articles/66e1cc17193168 • Next.js製 個人ブログに zenn-markdown-html と zenn-content-css を導入する • https://zenn.dev/team_zenn/articles/intro-zenn-markdown