Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# 貢献ガイド / Contribution Guide

Auto-coder-agent_Cursor_Roo_codeプロジェクトへの貢献に興味をお持ちいただき、ありがとうございます。このガイドでは、プロジェクトへの貢献方法について説明します。

Thank you for your interest in contributing to the Auto-coder-agent_Cursor_Roo_code project. This guide explains how to contribute to the project.

## 詳細な貢献ガイドライン / Detailed Contribution Guidelines

詳細な貢献ガイドラインについては、[貢献ガイドライン](docs/contribution/contributing.md)を参照してください。

For detailed contribution guidelines, please refer to the [Contribution Guidelines](docs/contribution/contributing.md).

## 行動規範 / Code of Conduct

このプロジェクトには[行動規範](docs/contribution/CODE_OF_CONDUCT.md)があります。プロジェクトに参加することにより、この行動規範を遵守することに同意したものとみなされます。

This project has a [Code of Conduct](docs/contribution/CODE_OF_CONDUCT.md). By participating in this project, you are expected to uphold this code.

## クイックスタート / Quick Start

1. リポジトリをフォークする / Fork the repository
2. 変更用のブランチを作成する / Create a branch for your changes
3. 変更を加える / Make your changes
4. テストを実行する / Run tests
5. 変更をコミットする / Commit your changes
6. プルリクエストを作成する / Create a pull request

## 貢献の種類 / Types of Contributions

- バグ修正 / Bug fixes
- 新機能の追加 / New features
- ドキュメントの改善 / Documentation improvements
- テストの追加 / Additional tests
- コードの最適化 / Code optimization

## 質問がある場合 / If You Have Questions

質問がある場合は、Issueを作成するか、プロジェクトのメンテナーに連絡してください。

If you have any questions, please create an Issue or contact the project maintainers.
74 changes: 74 additions & 0 deletions docs/contribution/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 行動規範 / 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, disability, ethnicity, gender characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## 私たちの基準 / Our Standards

前向きな環境を作り出すことに貢献する行動の例:
Examples of behavior that contributes to creating a positive environment include:

* 歓迎的かつ包括的な言葉を使用する
Using welcoming and inclusive language
* 異なる視点や経験を尊重する
Being respectful of differing viewpoints and experiences
* 建設的な批評を優雅に受け入れる
Gracefully accepting constructive criticism
* コミュニティにとって何が最善かに焦点を当てる
Focusing on what is best for the community
* 他のコミュニティメンバーに共感を示す
Showing empathy towards other community members

参加者による容認できない行動の例:
Examples of unacceptable behavior by participants include:

* 性的な言葉や画像の使用、および不快な性的注目や誘い
The use of sexualized language or imagery and unwelcome sexual attention or advances
* トローリング、侮辱的/軽蔑的なコメント、個人的または政治的攻撃
Trolling, insulting/derogatory comments, and personal or political attacks
* 公的または私的な嫌がらせ
Public or private harassment
* 明示的な許可なく、物理的または電子的な住所などの他者の個人情報を公開すること
Publishing others' private information, such as a physical or electronic address, without explicit permission
* 職業的な場において合理的に不適切と考えられるその他の行為
Other conduct which could reasonably be considered inappropriate in a professional setting

## 私たちの責任 / Our Responsibilities

プロジェクトメンテナーは、許容される行動の基準を明確にする責任があり、容認できない行動に対して適切かつ公正な是正措置を取ることが期待されています。

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

プロジェクトメンテナーは、この行動規範に沿わないコメント、コミット、コード、Wiki編集、課題、およびその他の貢献を削除、編集、または拒否する権利と責任を持ち、適切と判断した場合には貢献者を一時的または永久的に追放する権利を持ちます。

Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## 範囲 / Scope

この行動規範は、個人がプロジェクトやそのコミュニティを代表している場合、プロジェクトスペースと公共スペースの両方に適用されます。プロジェクトやコミュニティを代表する例としては、公式プロジェクトの電子メールアドレスの使用、公式ソーシャルメディアアカウントを通じての投稿、オンラインまたはオフラインのイベントでの代表者としての行動などがあります。プロジェクトの代表は、プロジェクトメンテナーによってさらに定義および明確化される場合があります。

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## 施行 / Enforcement

虐待的、嫌がらせ、またはその他の容認できない行動の事例は、プロジェクトチーム([メールアドレスを挿入])に連絡することで報告できます。すべての苦情は審査および調査され、状況に応じて必要かつ適切と判断される対応が取られます。プロジェクトチームは、事件の報告者に関する機密を守る義務があります。特定の施行ポリシーの詳細は別途投稿される場合があります。

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

この行動規範に誠意を持って従わない、または施行しないプロジェクトメンテナーは、プロジェクトをリードする他のメンバーの決定により、一時的または永久的な影響を受ける場合があります。

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## 帰属 / Attribution

この行動規範は、[Contributor Covenant][homepage]バージョン1.4から適応されています。
[https://www.contributor-covenant.org/version/1/4/code-of-conduct.html][version]

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
215 changes: 215 additions & 0 deletions docs/contribution/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,215 @@
# 貢献ガイドライン / Contribution Guidelines

## はじめに / Introduction
Auto-coder-agent_Cursor_Roo_codeプロジェクトへの貢献に興味をお持ちいただき、ありがとうございます。このガイドラインは、プロジェクトへの貢献方法を説明します。
Thank you for your interest in contributing to the Auto-coder-agent_Cursor_Roo_code project. These guidelines explain how to contribute to the project.

## 貢献の種類 / Types of Contributions
以下のような様々な方法でプロジェクトに貢献できます:
You can contribute to the project in various ways:

1. **バグ報告 / Bug Reports**
- 発見したバグを報告する
- Report bugs you discover

2. **機能リクエスト / Feature Requests**
- 新機能のアイデアを提案する
- Suggest ideas for new features

3. **ドキュメント改善 / Documentation Improvements**
- ドキュメントの追加や修正
- Add or modify documentation

4. **コード貢献 / Code Contributions**
- バグ修正や新機能の実装
- Fix bugs or implement new features

5. **テスト追加 / Adding Tests**
- 単体テストや統合テストの追加
- Add unit tests or integration tests

## 貢献プロセス / Contribution Process

### 1. 問題の作成 / Create an Issue
新しい貢献を始める前に、まず問題(Issue)を作成してください:
Before starting a new contribution, first create an issue:

1. GitHubリポジトリの「Issues」タブを開きます。
Open the "Issues" tab in the GitHub repository.

2. 「New Issue」ボタンをクリックします。
Click the "New Issue" button.

3. 適切なテンプレートを選択し、必要な情報を入力します。
Select the appropriate template and fill in the required information.

4. 「Submit new issue」をクリックして問題を作成します。
Click "Submit new issue" to create the issue.

### 2. フォークとクローン / Fork and Clone
リポジトリをフォークしてローカル環境にクローンします:
Fork the repository and clone it to your local environment:

1. GitHubリポジトリページの右上にある「Fork」ボタンをクリックします。
Click the "Fork" button in the top right of the GitHub repository page.

2. フォークしたリポジトリをローカル環境にクローンします:
Clone the forked repository to your local environment:
```bash
git clone https://github.com/YOUR_USERNAME/Auto-coder-agent_Cursor_Roo_code.git
cd Auto-coder-agent_Cursor_Roo_code
```

3. オリジナルリポジトリをリモートとして追加します:
Add the original repository as a remote:
```bash
git remote add upstream https://github.com/ShunsukeHayashi/Auto-coder-agent_Cursor_Roo_code.git
```

### 3. ブランチの作成 / Create a Branch
新しい機能やバグ修正のためのブランチを作成します:
Create a branch for a new feature or bug fix:

```bash
git checkout -b feature/your-feature-name
# または / or
git checkout -b fix/your-bug-fix
```

### 4. 変更の実装 / Implement Changes
ローカル環境で変更を実装します:
Implement changes in your local environment:

1. コードエディタで必要な変更を行います。
Make the necessary changes in your code editor.

2. プロジェクトのコーディング規約に従ってください。
Follow the project's coding conventions.

3. 適切なテストを追加または更新します。
Add or update appropriate tests.

4. ドキュメントを更新します(必要な場合)。
Update documentation (if necessary).

### 5. 変更のコミット / Commit Changes
変更をコミットします:
Commit your changes:

```bash
git add .
git commit -m "feat: Add new feature" # または / or "fix: Fix bug in ..."
```

コミットメッセージは[Conventional Commits](https://www.conventionalcommits.org/)の形式に従ってください。
Follow the [Conventional Commits](https://www.conventionalcommits.org/) format for commit messages.

### 6. 変更のプッシュ / Push Changes
変更をフォークしたリポジトリにプッシュします:
Push changes to your forked repository:

```bash
git push origin feature/your-feature-name
```

### 7. プルリクエストの作成 / Create a Pull Request
GitHubでプルリクエスト(PR)を作成します:
Create a Pull Request (PR) on GitHub:

1. フォークしたリポジトリページに移動します。
Go to your forked repository page.

2. 「Compare & pull request」ボタンをクリックします。
Click the "Compare & pull request" button.

3. PRの詳細を入力します:
Fill in the PR details:
- タイトル:変更内容を簡潔に説明
- 説明:変更の詳細、関連する問題へのリンク
- Title: Briefly explain the changes
- Description: Details of changes, links to related issues

4. 「Create pull request」をクリックしてPRを作成します。
Click "Create pull request" to create the PR.

## コーディング規約 / Coding Conventions

### 一般的なガイドライン / General Guidelines
- 一貫性のあるコードスタイルを維持する
Maintain consistent code style
- 適切なコメントを追加する
Add appropriate comments
- 複雑なロジックは説明する
Explain complex logic
- 変数名と関数名は明確で説明的にする
Make variable and function names clear and descriptive

### 言語固有のガイドライン / Language-Specific Guidelines

#### Markdown
- 見出しは階層構造に従う
Headings follow hierarchical structure
- コードブロックは言語を指定する
Specify language for code blocks
- リンクは適切に機能することを確認する
Ensure links function properly

#### JavaScript/TypeScript
- ESLintの規則に従う
Follow ESLint rules
- 非同期処理はPromiseまたはasync/awaitを使用する
Use Promises or async/await for asynchronous operations
- 型定義を適切に行う(TypeScript)
Define types appropriately (TypeScript)

#### Python
- PEP 8スタイルガイドに従う
Follow PEP 8 style guide
- docstringを使用して関数とクラスを文書化する
Document functions and classes using docstrings
- 型ヒントを使用する(Python 3.6+)
Use type hints (Python 3.6+)

## テスト / Testing
新しい機能やバグ修正には、適切なテストを追加してください:
Add appropriate tests for new features or bug fixes:

1. 単体テストは`tests/`ディレクトリに追加します。
Add unit tests to the `tests/` directory.

2. テストを実行して、すべてのテストがパスすることを確認します:
Run tests to ensure all tests pass:
```bash
# テスト実行コマンド(プロジェクトによって異なる場合があります)
# Test execution command (may vary depending on the project)
npm test # または / or pytest
```

## レビュープロセス / Review Process
プルリクエストは以下のプロセスでレビューされます:
Pull requests are reviewed with the following process:

1. 自動チェック(CI)がパスすることを確認します。
Ensure automatic checks (CI) pass.

2. プロジェクトメンテナがコードをレビューします。
Project maintainers review the code.

3. フィードバックがある場合は、必要な変更を行います。
Make necessary changes if there is feedback.

4. すべての要件を満たしたら、PRがマージされます。
Once all requirements are met, the PR will be merged.

## コミュニティ / Community
質問や議論は、以下のチャネルで行うことができます:
Questions and discussions can be conducted through the following channels:

- GitHub Issues
- GitHub Discussions
- プロジェクトのコミュニティチャット(存在する場合)
Project community chat (if it exists)

## 行動規範 / Code of Conduct
すべての貢献者は、プロジェクトの行動規範に従うことが期待されます。詳細は[CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)を参照してください。
All contributors are expected to follow the project's code of conduct. For details, refer to [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
Loading