【GROWI ファン向け】GROWI の開発に参加する方法

GROWI Logo

皆さんこんにちは!WESEEK ソフトウェアエンジニアの 増山 です。

今回のブログでは、WESEEK で絶賛開発中の OSS Wiki システム GROWI の開発に参加する方法を解説していきたいと思います。

参加する目的別に主に5種類の方法が存在するので、それら全てについて説明します。

目次

機能リクエストをしたい、GROWI について議論をしたい

そんなときは Github の Discussion を使います。

Discussion の使い方

  1. GROWI の Github Discussion にアクセス
  2. "New Discussion" をクリック
  3. "Select Category" から Discussion の種類を選んで、タイトルと本文を記入
  4. 最後に "Start Discussion" を押して Discussion を作成

バグを見つけたので修正して欲しい

こんなときは Github の Issue を使います。

Issue の使い方

  1. GROWI の Github Issues にアクセス
  2. "New Issue" をクリック
  3. 選択肢の中から Issue の種類を選ぶ
  4. テンプレートが表示されるので、それに沿って Issue を作成
    • 作成されると GROWI 開発チームに通知が飛ぶ仕組みになっています

自分でコードを書いて GROWI に反映したい

こんなときは Github の Pull Request を使います。

Git に関する詳しい説明はここではしません。

Pull Request の使い方

  1. GROWI を git clone する
  2. master ブランチから作業用ブランチを切り、コードを書く
  3. 作業用ブランチをプッシュ
  4. GROWI の Github Issues にアクセス
  5. "New pull request" をクリック
  6. 選択肢の中から Issue の種類を選ぶ
  7. ベースブランチを master に向けて PR を作成
    • 作成されると GROWI 開発チームに通知が飛ぶ仕組みになっています
  8. 最後に CI が通っているかを確認

GROWI の会議に参加したい

GROWI チームでは、毎月誰でも参加可能GROWI Users Meetup というオープンなオンライン会議を開催しています。

最新バージョンの機能紹介や、テーマに沿って議論する"オープン村議"のコーナーなどがあります。

より身近に GROWI 開発に参加してみたいにおすすめです。Youtube Live でも配信しているので、「まずは見てみたい」という方も気軽に参加いただけます。

開発チームと連絡を取りたい

何か困ったことがある場合や、「PR 作ったぞ!早くみてくれ!」ってなった場合は #GROWI をつけてツイートしてください。
また、Slack のチャンネルでも気軽にご質問いただけます。

言語について

GROWI のソースコードやコミットメッセージは基本的に英語で統一されていますが、Discussion、Issue、Pull Request など含め日本語を使っても OK です。

最後に

ここまで記事をお読みいただきありがとうございました。

GROWI は OSS ですので、皆さんも気軽に開発にご参加いただけます。まずは Discussion で日頃 GROWI に対して思っていることを投稿してみてはいかがでしょうか?

皆さんと一緒に開発できるのを楽しみにしています!

次回 GROWI Users Meetup のお知らせ

次回 7月25日(月) の GROWI Users Meetup では、初の試みである "オープンペアプロ" を実施します。

GROWI 開発チームのインターン生と、この記事を書いている 増山 が皆さんにコードを書いているところをお見せしながら、実際の GROWI 開発ペアプロという形で行います!

参加申し込みは以下のリンクからどうぞ!

connpass:
https://weseek.connpass.com/event/252069/

TECH PLAY:
https://techplay.jp/event/863484