You are currently viewing OpenSearchドキュメントに修正依頼を出してみる

OpenSearchドキュメントに修正依頼を出してみる

ちょっと前に「Let’s Go Talk」というイベントに登壇させていただきました。
その時同じく登壇されたエンジニアの方に「OpenSearchのドキュメントはGitHubで管理されているから、修正のプルリクを出してるのが良いかも」とアドバイスを頂いたので、今回修正依頼を出してみることにしました。

OpenSearchドキュメントのURL

https://github.com/opensearch-project

こちらになります。

今回修正を依頼したいのはGo Clientの項目で、レスポンスを利用したあとはCloseする必要があるのでは? というのを打診してみようと思います。

Contribution Guideを参考に修正

殆どのOSSで「Contribution Guide」が準備されているかと思います。
プロジェクトに修正依頼を行う際の決まり事が書いてあるドキュメントになります。

OpenSearchにも準備されていますので、これに基づいて修正依頼を出してみようと思います。
https://github.com/opensearch-project/documentation-website/blob/main/CONTRIBUTING.md

ざっくり確認すると、Pull Requestを作成する方法とIssueを立てる方法の2種類の方法があるようです。
今回は単純な修正のため、Pull Requestを立てる方針で修正依頼を出してみようと思います。

出してみた

ということで、気になった部分の修正を行い、プルリクエストを出してみました。
https://github.com/opensearch-project/documentation-website/pull/2828

今回DCOというものを初めて知りました。
署名が必要になるのですが、実名での記載が必要とのこと・・・
結構海外ではネット上でも実名でやり取りすることが多いと感じていますが、今までずっとハンドルネームでネット上では活動しているので、実名はちょっと抵抗がありますね。

以上

ということで、 OpenSearchのドキュメントに修正依頼を出してみたお話でした。
プログラムそのものを修正するのはなかなか敷居が高いと感じますが、ドキュメント修正など、手をつけられる部分でOSSの発展に貢献する方法もありますね。

コメントを残す