agi-brain
diff --git a/‎CODE_OF_CONDUCT.md
+78 b/‎CODE_OF_CONDUCT.md
+78
diff --git a/‎CONTRIBUTING.md
+133 b/‎CONTRIBUTING.md
+133
diff --git a/‎CONTRIBUTING_CN.md
+103 b/‎CONTRIBUTING_CN.md
+103
@@ -0,0 +1,78 @@
+# Contributor Covenant 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 identity and expression, level of experience, nationality, personal appearance, race, 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** for our mistakes, and **learning from them**
+- **Focusing on what is best** for the community
+- **Showing patience** and **understanding** toward new and less experienced community members
+
+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 electronic address, without 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 at liu [_] wzh [at] foxmail [dot] com. 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 additional details about 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.
+
+### 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.
+
+### 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][https://www.contributor-covenant.org/], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct/](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+Translations are available at [https://www.contributor-covenant.org/translations/](https://www.contributor-covenant.org/translations/)
@@ -0,0 +1,133 @@
+# Contributing to XuanCe
+
+Thank you for your interest in contributing to **XuanCe**! We welcome and appreciate contributions from the community to help improve and expand this deep reinforcement learning library. By participating in this project, you help make XuanCe more robust, versatile, and user-friendly for researchers, developers, and enthusiasts alike.
+
+## Table of Contents
+
+- [How to Contribute](#how-to-contribute)
+  - [Reporting Issues](#reporting-issues)
+  - [Suggesting Enhancements](#suggesting-enhancements)
+  - [Contributing Code](#contributing-code)
+- [Coding Guidelines](#coding-guidelines)
+- [Setting Up the Development Environment](#setting-up-the-development-environment)
+- [Pull Request Process](#pull-request-process)
+- [Code of Conduct](#code-of-conduct)
+- [Need Help?](#need-help)
+
+## How to Contribute
+
+### Reporting Issues
+
+If you encounter a bug, have a feature request, or find something unclear, please help us by creating an issue:
+
+1. Go to the [Issues](https://github.com/agi-brain/xuance/issues) page.
+2. Click on **New Issue**.
+3. Choose the appropriate template (bug report, feature request, etc.).
+4. Provide a clear and descriptive title.
+5. Fill out the template with as much detail as possible, including steps to reproduce the issue, expected behavior, actual behavior, and any relevant screenshots or logs.
+
+### Suggesting Enhancements
+
+We welcome suggestions for new features or improvements:
+
+1. Open a new issue on the [Issues](https://github.com/agi-brain/xuance/issues) page.
+2. Choose the **Feature Request** template.
+3. Clearly describe the enhancement or feature you have in mind.
+4. Explain the problem it solves or the benefit it provides.
+
+### Contributing Code
+
+If you'd like to contribute code to XuanCe, please follow these steps:
+
+1. **Fork the Repository**
+   - Click the **Fork** button at the top-right corner of the [XuanCe GitHub repository](https://github.com/agi-brain/xuance).
+   
+2. **Clone Your Fork**
+   ```bash
+   git clone https://github.com/<your-username>/xuance.git
+   cd xuance
+
+3. **Create a New Branch**
+   - Use a descriptive branch name.
+    
+    ```bash
+    git checkout -b branch-name
+    ```
+   
+4. **Make Your Changes**
+   - Implement your feature or bug fix.
+   - Ensure your code adheres to the project's coding standards.
+
+5. **Run Tests**
+   - Ensure all existing tests pass. 
+   - Add new tests for your changes if applicable.
+
+6. **Commit Your Changes**
+   - Write a clear and concise commit message.
+   ```bash
+   git commit -m "short-description"
+   ```
+   
+7. **Push to Your Fork**
+    ```bash
+    git push origin branch-name
+    ```
+   
+8. **Create a Pull Request**
+   - Navigate to your fork on GitHub.
+   - Click the Compare & pull request button.
+   - Provide a detailed description of your changes.
+   - Submit the pull request to the main branch of the original XuanCe repository.
+
+### Coding Guidelines
+
+To maintain consistency and quality across the project, please follow these guidelines:
+- Follow PEP 8: Adhere to PEP 8 coding standards for Python.
+- Meaningful Names: Use clear and descriptive names for variables, functions, classes, and modules.
+- Docstrings and Comments: Provide comprehensive docstrings for all public modules, functions, classes, and methods. Use comments to explain complex logic.
+- Modular Code: Write modular and reusable code. Break down large functions into smaller, manageable pieces.
+- Error Handling: Implement proper error handling to make the library robust and user-friendly.
+- Testing: Write unit tests for new features and bug fixes. Ensure that all tests pass before submitting a pull request.
+- Documentation: Update the documentation to reflect any changes or additions to the codebase.
+
+### Pull Request Process
+
+1. Ensure Your Branch is Up to Date
+   - Sync your fork with the original repository to avoid merge conflicts.
+
+2. Submit a Pull Request
+   - Provide a clear title and detailed description of your changes.
+   - Reference any related issues using keywords like Closes #123.
+
+3. Address Feedback
+   - Collaborate with maintainers to make necessary revisions.
+         
+4. Final Approval
+   - Once approved, your pull request will be merged into the main branch.
+
+### Code of Conduct
+
+By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). 
+Please read it to understand the expectations for participation.
+
+### Contributing to Documentation
+
+Contributing to documentation improvements is highly valuable to us. Please follow the steps below to update or add documentation:
+
+- **Locate Documentation Files:** Documentation is located in the `docs/` directory.
+- **Make Changes:** Update existing documentation or add new documentation files.
+- **Build Documentation Locally:** Follow the documentation build guide to preview your changes locally.
+- **Submit a Pull Request (PR):** Ensure your documentation changes are clear, properly formatted, and describe the changes made in your PR.
+
+### Contact Us
+
+If you have any questions or need further assistance, please contact us through the following methods:
+
+- **Email:** liu [_] wzh [at] foxmail [dot] com
+- **GitHub Issues:** [Create a new issue](https://github.com/agi-brain/xuance/issues)
+- **Discussions:** [Join the discussion](https://github.com/agi-brain/xuance/discussions)
+- **Discord:** [https://discord.gg/HJn2TBQS7y](https://discord.gg/HJn2TBQS7y)
+- **Slack:** [https://join.slack.com/t/xuancerllib/](https://join.slack.com/t/xuancerllib/shared_invite/zt-2x2r98msi-iMX6mSVcgWwXYj95abcXIw)
+- **QQ group:** 552432695
+
+Thank you for contributing to XuanCe! Your efforts help make this library a valuable resource for the community.
@@ -0,0 +1,103 @@
+# 贡献指南
+
+感谢您对 [XuanCe](https://github.com/agi-brain/xuance) 项目的兴趣！我们欢迎各种形式的贡献，包括但不限于报告错误、提出功能建议、改进文档以及代码贡献。以下是如何参与贡献的详细指南。
+
+## 行为准则
+
+请在参与贡献前阅读并遵守我们的 [行为准则](CODE_OF_CONDUCT.md)。我们致力于维护一个友好、包容和尊重的社区环境，确保每位贡献者都能感受到欢迎和尊重。
+
+## 如何贡献
+
+### 报告问题
+
+如果您在使用 XuanCe 时发现了错误或有改进建议，请通过以下步骤报告问题：
+
+1. **检查现有问题：** 在提交新问题前，请先浏览 [现有问题](https://github.com/agi-brain/xuance/issues)，确保您的问题尚未被报告。
+2. **创建新问题：** 点击 “New issue” 按钮，选择合适的问题模板（如 Bug 报告或功能请求）。
+3. **详细描述：** 提供详细的问题描述，包括重现步骤、预期行为、实际行为以及任何相关的日志或截图。
+
+### 提出功能建议
+
+如果您有关于 XuanCe 的新功能或改进建议，请按照以下步骤操作：
+
+1. **检查现有建议：** 在提交新建议前，请先浏览 [现有建议](https://github.com/agi-brain/xuance/issues)，确保您的建议尚未被提出。
+2. **创建新建议：** 点击 “New issue” 按钮，选择 “Feature request” 模板。
+3. **详细描述：** 清晰地描述您的建议，包括功能的用途、预期效果以及可能的实现方式。
+
+### 提交 Pull Request
+
+我们鼓励您通过提交 Pull Request (PR) 的方式为项目做出贡献。以下是提交 PR 的步骤：
+
+1. **Fork 仓库：**
+   - 点击 [XuanCe GitHub 页面](https://github.com/agi-brain/xuance) 右上角的 “Fork” 按钮，将仓库复制到您的账户下。
+
+2. **克隆您的 Fork：**
+   ```bash
+   git clone https://github.com/您的用户名/xuance.git
+   cd xuance
+   
+3. **创建新分支：**
+   ```bash
+   git checkout -b 您的分支名称
+   ```
+   
+4. **更改您的代码：**
+   - 接下来在您本地对克隆下来的代码进行修改。
+   - 注意保持代码风格和 XuanCe 项目保持一致。
+   
+5. **运行测试：**
+   - 确保所作改动正常通过测试。
+   - 可在项目主目录下的``./tests``文件夹中新增测试用例（如有需要）。
+
+6. **提交更改：**
+   ```bash
+   git add .
+   git commit -m '简要描述您的更改'
+   ```
+   
+7. **推送到您的 Fork：**
+   ```bash
+   git push origin 您的分支名称
+   ```
+   
+8. **创建 Pull Request：**
+   - 前往您的仓库页面。
+   - 点击“Compare & pull request”按钮。
+   - 填写 PR 标题和详细描述，解释您的更改内容和目的。
+   - 提交 PR。
+
+### 代码风格
+
+请遵循以下代码风格指南，以确保代码的一致性和可读性：
+- PEP 8 标准： 遵循 PEP 8 Python 代码风格指南。 
+- 命名约定： 使用有意义的变量和函数名称，遵循驼峰命名法或下划线命名法。
+- 文档字符串： 为所有公共模块、类和函数编写清晰的文档字符串。
+- 注释： 对复杂的代码段添加注释，解释其功能和逻辑。
+
+### 测试
+
+确保您的贡献包含适当的测试。请按照以下步骤添加和运行测试：
+- 添加测试用例： 在 tests/ 目录下为新功能或修复添加测试用例。
+- 确保所有测试通过： 在提交 PR 前，确保所有测试均通过，并且没有引入新的错误。
+
+### 文档贡献
+
+贡献文档改进对我们非常重要。请按照以下步骤更新或添加文档：
+- 定位文档文件： 文档位于 docs/ 目录下。
+- 进行更改： 更新现有文档或添加新的文档文件。
+- 本地构建文档： 按照文档构建指南在本地预览您的更改。
+- 提交 PR： 确保您的文档更改清晰、格式正确，并在 PR 中说明改动内容。
+
+### 许可证
+
+通过贡献，您同意将您的贡献许可给 XuanCe 项目，根据 MIT 许可证进行授权。
+
+### 联系方式
+如果您有任何问题或需要进一步的帮助，请通过以下方式与我们联系：
+- GitHub Issues: https://github.com/agi-brain/xuance/issues
+- QQ群：552432695
+- 微信公众号后台："玄策 RLlib"
+- Discord: [https://discord.gg/HJn2TBQS7y](https://discord.gg/HJn2TBQS7y)
+- Slack: [https://join.slack.com/t/xuancerllib/](https://join.slack.com/t/xuancerllib/shared_invite/zt-2x2r98msi-iMX6mSVcgWwXYj95abcXIw)
+
+感谢您的贡献和支持！通过您的帮助，XuanCe 将变得更加强大和实用。