diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..6bd972b --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,134 @@ +# Contributor Covenant Code of Conduct + +> 日本語訳は [行動規範(日本語)](https://cyberagent.github.io/ChilmAI/development/code-of-conduct/) を参照してください。 + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances + of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail +address, posting via an official social media account, or acting as an +appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement via +[the reporting form](https://docs.google.com/forms/d/e/1FAIpQLScAbG8AsVnXq8EPWNHtDCmI5ch1C1QPkGJJC9V-ubtx4BYYkw/viewform). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f0e34e..a63a165 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,10 @@ ChilmAI へのコントリビューションに興味を持っていただき、 ## 始める前に +### 行動規範 + +Issue、Pull Request、コメントなど、ChilmAI のコミュニティでのやり取りには [行動規範](CODE_OF_CONDUCT.md) が適用されます。日本語訳は [行動規範（日本語）](https://cyberagent.github.io/ChilmAI/development/code-of-conduct/) を参照してください。 + ### 対象範囲 ChilmAI の主な開発対象は以下です。 diff --git a/README.md b/README.md index 790df7b..d8c6118 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,9 @@ coverage
+ + PyPI + Python 3.10-3.12 Apache-2.0 @@ -49,9 +52,7 @@ Windows 11（64-bit）では、最新リリースの [ChilmAI-latest.zip](https: ### ライブラリとして利用する -Python 3.10 〜 3.12 の環境に、PyPI からインストールします。パッケージに含まれるのはコアライブラリ（`chilmai`）のみで、Web UI・HTTP API のリファレンス実装（`apps/`）とサンプルデータは含まれません。 - - +Python 3.10 〜 3.12 の環境に、[PyPI](https://pypi.org/project/chilmai/) からインストールします。パッケージに含まれるのはコアライブラリ（`chilmai`）のみで、Web UI・HTTP API のリファレンス実装（`apps/`）とサンプルデータは含まれません。 ```bash pip install chilmai @@ -86,7 +87,7 @@ Python API のサンプルは [インストールと実行](https://cyberagent.g ## コントリビューション -バグ報告、機能提案、ドキュメント改善、Pull Request を歓迎します。参加方法は [コントリビューション](https://cyberagent.github.io/ChilmAI/development/contributing/) を参照してください。セキュリティ上の懸念は公開 Issue に投稿せず、[セキュリティ](https://cyberagent.github.io/ChilmAI/reference/security/) に記載された方法で報告してください。 +バグ報告、機能提案、ドキュメント改善、Pull Request を歓迎します。参加方法は [コントリビューション](https://cyberagent.github.io/ChilmAI/development/contributing/) を参照してください。コミュニティでのやり取りには [行動規範](CODE_OF_CONDUCT.md)（[日本語訳](https://cyberagent.github.io/ChilmAI/development/code-of-conduct/)）が適用されます。セキュリティ上の懸念は公開 Issue に投稿せず、[セキュリティ](https://cyberagent.github.io/ChilmAI/reference/security/) に記載された方法で報告してください。 ## ライセンス diff --git a/docs/development/code-of-conduct.md b/docs/development/code-of-conduct.md new file mode 100644 index 0000000..3b26f4d --- /dev/null +++ b/docs/development/code-of-conduct.md @@ -0,0 +1,79 @@ +# 行動規範 + +本ページは [Contributor Covenant バージョン 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) に基づく ChilmAI の行動規範の日本語訳です。正文はリポジトリルートの [CODE_OF_CONDUCT.md](https://github.com/CyberAgent/ChilmAI/blob/main/CODE_OF_CONDUCT.md)(英語)です。 + +## 私たちの誓い + +メンバー、コントリビューター、リーダーである私たちは、年齢、体格、目に見える・見えない障害、民族、性的特徴、性自認と性表現、経験の程度、学歴、社会経済的地位、国籍、容姿、人種、カースト、肌の色、宗教、性的アイデンティティと性的指向にかかわらず、すべての人にとってハラスメントのないコミュニティへの参加体験を提供することを誓います。 + +私たちは、開かれた、歓迎的で、多様で、包摂的で、健全なコミュニティに貢献するように行動し、交流することを誓います。 + +## 私たちの基準 + +コミュニティにとって良い環境をつくることに貢献する行動の例: + +- 他者への共感と思いやりを示す +- 異なる意見、視点、経験を尊重する +- 建設的なフィードバックを与え、また快く受け入れる +- 自分の過ちによって影響を受けた人々に責任を認めて謝罪し、その経験から学ぶ +- 自分個人にとってだけでなく、コミュニティ全体にとって何が最善かを考えて行動する + +許容されない行動の例: + +- 性的な言葉や画像の使用、およびあらゆる形の性的な注目や誘い +- 荒らし行為、侮辱的・軽蔑的なコメント、個人攻撃や政治的な攻撃 +- 公開の場や私的な場でのハラスメント +- 明示的な許可のない、住所やメールアドレスなど他者の個人情報の公開 +- 職業上の場において不適切と合理的に考えられるその他の行動 + +## 執行の責任 + +コミュニティリーダーは、許容される行動の基準を明確にして執行する責任を負い、不適切、脅迫的、攻撃的、または有害と判断した行動に対して、適切かつ公正な是正措置を講じます。 + +コミュニティリーダーは、この行動規範に沿わないコメント、コミット、コード、Wiki の編集、Issue、その他のコントリビューションを削除、編集、または却下する権利と責任を持ち、適切な場合にはモデレーションの理由を伝えます。 + +## 適用範囲 + +この行動規範は、すべてのコミュニティスペースに適用されます。また、個人が公の場でコミュニティを公式に代表する場合にも適用されます。コミュニティを代表する例としては、公式メールアドレスの使用、公式 SNS アカウントでの投稿、オンラインまたはオフラインのイベントでの指名された代表者としての行動などがあります。 + +## 執行 + +虐待的な行動、ハラスメント、その他の許容されない行動を見聞きした場合は、[報告フォーム](https://docs.google.com/forms/d/e/1FAIpQLScAbG8AsVnXq8EPWNHtDCmI5ch1C1QPkGJJC9V-ubtx4BYYkw/viewform)から、執行を担当するコミュニティリーダーに報告できます。すべての報告は、迅速かつ公正に確認・調査されます。 + +すべてのコミュニティリーダーは、報告者のプライバシーとセキュリティを尊重する義務を負います。 + +## 執行ガイドライン + +コミュニティリーダーは、この行動規範に違反すると判断した行動への対応を決めるにあたり、以下のコミュニティへの影響に関するガイドラインに従います。 + +### 1. 是正 + +**コミュニティへの影響**: 不適切な言葉づかい、またはコミュニティにおいて職業倫理に反する、もしくは歓迎されないと見なされるその他の行動。 + +**対応**: コミュニティリーダーからの非公開の書面による警告。違反の内容を明確にし、その行動がなぜ不適切だったのかを説明します。公開の場での謝罪を求める場合があります。 + +### 2. 警告 + +**コミュニティへの影響**: 単一の事案または一連の行動による違反。 + +**対応**: 行動を続けた場合の措置を伴う警告。一定期間、関係者との接触を禁止します。これには、行動規範を執行する担当者への一方的な接触も含まれます。コミュニティスペースだけでなく、SNS などの外部チャネルでの接触も避けてください。この条件に違反した場合、一時的または恒久的な参加禁止につながることがあります。 + +### 3. 一時的な参加禁止 + +**コミュニティへの影響**: 不適切な行動の継続を含む、コミュニティの基準への重大な違反。 + +**対応**: 一定期間、コミュニティとのあらゆる形の交流や公開のコミュニケーションを禁止します。この期間中は、関係者との公開・非公開を問わない接触(行動規範を執行する担当者への一方的な接触を含む)は許可されません。この条件に違反した場合、恒久的な参加禁止につながることがあります。 + +### 4. 恒久的な参加禁止 + +**コミュニティへの影響**: 不適切な行動の継続、個人へのハラスメント、特定の属性を持つ人々への攻撃や中傷など、コミュニティの基準への違反を繰り返すパターンを示すこと。 + +**対応**: コミュニティ内でのあらゆる形の公開の交流を恒久的に禁止します。 + +## 帰属 + +この行動規範は [Contributor Covenant](https://www.contributor-covenant.org) バージョン 2.1 を基にしています。原文は で参照できます。 + +コミュニティへの影響に関するガイドラインは、[Mozilla の行動規範執行ラダー](https://github.com/mozilla/diversity)に着想を得ています。 + +この行動規範に関するよくある質問への回答は を、翻訳は を参照してください。 diff --git a/docs/index.md b/docs/index.md index 3c9c204..202e721 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,6 +15,9 @@ coverage
+ + PyPI + Python 3.10-3.12 Apache-2.0 diff --git a/mkdocs.yml b/mkdocs.yml index 75b9023..c0325bc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,6 +44,7 @@ nav: - カスタマイズ: development/customization.md - 開発に参加する: - コントリビューション: development/contributing.md + - 行動規範: development/code-of-conduct.md - アーキテクチャ: development/architecture.md - テスト: development/testing.md - リリースフロー: development/workflows.md