Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (40 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 2.32 KB

Welcome to the UniProject's GitHub Organization 🙌

デジタル創作サークル UniProject の GitHub Organization へようこそ！

この GitHub Organization では、以下のものを管理しています。

  • UniPro のインフラ基盤の設定ファイル
  • UniPro 内製ソフトウェアのソースコード
  • UniPro メンバーの開発したソフトウェア
  • その他関連プロジェクト

📗 Organization Rules

この Organization を利用するにあたってのルールです。

🔁 Pull Request Process

この Organization 内のリポジトリへ貢献する際の手順です。

  1. 変更を行う前に、Issue・メールなどで管理者と内容を共有してください。

  2. ビルド時は、不要なインストール・ビルド依存関係をレイヤー終了前に削除してください。

  3. インターフェース変更があった場合は README.md を更新してください。

    • 新しい環境変数
    • 公開ポート
    • 重要なファイルパス
    • コンテナパラメータ など

  4. バージョンが変更される場合は、README やサンプルファイルのバージョン番号も更新してください。

  5. 他の開発者2名の承認後にマージ可能です。

    • 権限がない場合は、レビュアーにマージ依頼をしてください。

🔖 Tag Process

タグを打つ際は semver 2.0 に準拠してください。

また、npm系のリポジトリの場合は、 npm version <major|minor|patch|pre...> を使用してください。 このnpm系のコマンドは通常のコミットを含むため、リポジトリオーナーは下記の2つのいずれかを行う必要があります。

  1. 自ら代行する
  2. プッシュの権限を与える

🧑‍🤝‍🧑 チームについて

  • チームは各プロジェクトの CODEOWNER 指定のために作成されています。
  • プロジェクト理解度が高いメンバーが所属しています。
  • 質問がある場合は、そのチームのメンバーに確認してください。
  • 新規チーム作成は 👉 @UniPro-tech/BoardMember へ依頼してください。

☑️ プロジェクト利用について

  • LICENSEファイルに基づいて利用可能です。