Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (49 loc) · 4.13 KB

CONTRIBUTING.md

File metadata and controls

68 lines (49 loc) · 4.13 KB
Raw

Contributing to TouchFish Client / 向 TouchFish Client 贡献

We welcome contributions from the community to help improve TouchFish Client! Whether you're reporting bugs, suggesting new features, or submitting code changes, your input is valuable to us.

我们欢迎社区的贡献来帮助改进 TouchFish Client！无论您是报告错误、建议新功能还是提交代码更改，您的意见对我们都很宝贵。

How to Contribute / 如何贡献

  1. Fork the Repository: Start by forking the TouchFish Client repository on GitHub to your own account. Fork 本仓库：首先在 GitHub 上将 TouchFish Client 仓库 fork 到您自己的账户中。

  2. Clone Your Fork: Clone your forked repository to your local machine using the following command: 克隆您的 Fork：使用以下命令将您 fork 的仓库克隆到本地机器：

    git clone https://github.com/YourUsername/TouchFish-Client.git

  3. Create a Branch: Create a new branch for your changes. Use a descriptive name for the branch that reflects the purpose of your changes. (using main is acceptable but not recommended) 创建分支：为您的更改创建一个新分支。使用一个描述性的名称来反映您更改的目的。（使用 main 是可以的，但不推荐）

    git checkout -b your-branch-name

  4. Make Changes: Make your changes to the codebase. Ensure that your code follows the existing coding style and conventions. 进行更改：对代码库进行更改。确保您的代码遵循现有的编码风格和约定。

  5. Test Your Changes: Before submitting your changes, make sure to test them thoroughly to ensure they work as expected and do not introduce new issues. 测试您的更改：在提交更改之前，确保对其进行彻底测试，以确保其按预期工作并且不会引入新的问题。

  6. Commit Your Changes: Commit your changes with a clear and concise commit message that describes what you have done. 提交您的更改：使用清晰简明的提交信息提交您的更改，描述您所做的工作。

    git add .
git commit -m "Your commit message"

  7. Push to Your Fork: Push your changes to your forked repository on GitHub. 推送到您的 Fork：将您的更改推送到 GitHub 上的 fork 仓库。

     git push origin your-branch-name

  8. Create a Pull Request: Go to the original TouchFish Client repository on GitHub and create a pull request from your forked repository. Provide a detailed description of your changes and why they should be merged. 创建拉取请求：转到 GitHub 上的原始 TouchFish Client 仓库，并从您 fork 的仓库创建一个拉取请求（Pull Request）。提供详细的更改描述以及为什么应该合并它们。

Requirements / 贡献要求

  • Ensure that your code is well-documented and follows best practices. 确保您的代码有良好的文档记录并遵循最佳实践。
  • Use descriptive names for branches and commit messages. 为分支和提交信息使用描述性名称。
  • Test your changes thoroughly before submitting a pull request. 在提交拉取请求之前彻底测试您的更改。
  • Be respectful and considerate in all communications. 在所有交流中保持尊重和体贴。
  • Follow the code of conduct outlined in this repository. 遵循本仓库中概述的行为准则。

License / 许可证

By contributing to TouchFish Client, you agree that your contributions will be licensed under the AGPLv3 License. Please ensure that your contributions do not violate any third-party licenses or intellectual property rights.

通过向 TouchFish Client 贡献，您同意您的贡献将根据 AGPLv3 许可证进行许可。请确保您的贡献不会侵犯任何第三方许可证或知识产权。

You should sign the CLA before submitting a pull request to confirm that you have the right to contribute the code and that you agree to the terms of the license. 在提交拉取请求之前，您应签署 CLA 以确认您有权贡献代码并且同意许可证的条款。