Skip to content

Latest commit

 

History

History
113 lines (74 loc) · 5.39 KB

CONTRIBUTING.md

File metadata and controls

113 lines (74 loc) · 5.39 KB
Raw

コントリビュート

Pull Request、GitHubレポジトリでのイシュー、f フォーラムでの議論や質問を通してプロジェクトに貢献していただけることをIncusチームは感謝します。

プロジェクトへ貢献する前に、以下のガイドラインを確認してください。

Code of Conduct

コントリビュートする際には、行動規範を遵守しなければなりません。行動規範は、以下のサイトから入手できます。https://github.com/lxc/incus/blob/main/CODE_OF_CONDUCT.md

ライセンスと著作権

デフォルトで、このプロジェクトに対するいかなる貢献も Apache 2.0 ライセンスの下で行われます。

変更の著者は、そのコードに対する著作権を保持します (著作権の譲渡はありません)。

Pull Request

このプロジェクトへの変更は、GitHubのhttps://github.com/lxc/incusでPull Requestとして提案してください。

提案された変更はそこでコードレビューを受け、承認されればメインブランチにマージされます。

コミット構成

コミットを次のように分類する必要があります。

  • API拡張（doc/api-extensions.mdとinternal/version/api.goを含む変更に対してapi: Add XYZ extension）
  • ドキュメント（doc/内のファイルに対してdoc: Update XYZ）
  • API構造（shared/api/の変更に対してshared/api: Add XYZ）
  • Goクライアントパッケージ（client/の変更に対してclient: Add XYZ）
  • CLI（cmd/の変更に対してcmd/<command>: Change XYZ）
  • Incusデーモン（incus/の変更に対してincus/<package>: Add support for XYZ）
  • テスト（tests/の変更に対してtests: Add test for XYZ）

同様のパターンがIncusコードツリーのほかのツールにも適用されます。 そして複雑さによっては、さらに小さな単位に分けられるかもしれません。

CLIツール（cmd/）内の文字列を更新する際は、テンプレートを更新してコミットする必要があります。

make i18n
git commit -a -s -m "i18n: Update translation templates" po/

API（shared/api）を更新する際は、swagger YAMLも更新してコミットする必要があります。

make update-api
git commit -s -m "doc/rest-api: Refresh swagger YAML" doc/rest-api.yaml

このようにすることで、コントリビューションに対するレビューが容易になり、安定ブランチへバックポートするプロセスが大幅に簡素化されます。

開発者の起源の証明

このプロジェクトへの貢献の追跡を改善するために、DCO 1.1を使用しており、ブランチに入るすべての変更に対して「サインオフ」手順を使用しています。

サインオフとは、あなたがそのコミットを書いたことを証明する、そのコミットの説明の最後にある単純な行です。 この行は、自分が書いたものであることを証明したり、オープンソースとして渡す権利があることを証明したりします。

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

有効なサインオフラインの例は以下の通りです。

Signed-off-by: Random J Developer <[email protected]>

実名と有効な電子メールアドレスを使用してください。 残念ながら、ペンネームや匿名での投稿はできません。

また、それぞれのコミットには作者が個別に署名する必要があります。 大きなセットの一部であってもです。git commit -sが役に立つでしょう。

そのほかの情報

より詳しい情報は、ドキュメントのContributingをご覧ください。