Skip to content

Latest commit

 

History

History
126 lines (83 loc) · 6.82 KB

CONTRIBUTING.md

File metadata and controls

126 lines (83 loc) · 6.82 KB

How to Contribute

Thank you for your interest and support in tRPC!

We welcome and appreciate any form of contribution, including but not limited to submitting issues, providing improvement suggestions, improving documentation, fixing bugs, and adding features.

This document aims to provide you with a detailed contribution guide to help you better participate in the project.

Please read this guide carefully before contributing and make sure to follow the rules here.

We look forward to working with you to make this project better together!

Before submitting an issue

Please make sure that you have reviewed the project's documentation, FAQ, and existing issues.

This can avoid submitting known issues repeatedly and save your and the project maintainer's time.

When you decide to submit an issue, please follow these rules:

  • Select appropriate labels for the issue. This helps us to quickly locate the problem and solve it as soon as possible.
  • Ensure that the issue title is concise and accurately summarizes the problem. Avoid using vague words such as "problem" or "error".

In the issue description, please provide a detailed description of the problem you encountered.

This includes but is not limited to the following:

  • Problem description: briefly describe the symptoms and impact of the problem.
  • Reproduction steps: describe in detail how to reproduce the problem, so that we can locate and solve the problem more quickly.
  • Environment information: relevant information including operating system, browser, project version, etc.
  • Error log: if there are relevant error logs, please provide them.
  • Expected results: describe what the correct result should be.
  • Screenshots or screen recordings: if possible, provide screenshots or screen recordings of the problem.

Please be polite and friendly.

We attach great importance to the environment of the project and hope that everyone can grow together in a friendly and inclusive environment.

Rules for submitting PRs

We welcome you to submit code for the project.

Before submitting a PR, please make sure that you have read this contribution guide.

Here are some suggestions and rules regarding submitting PRs.

Please read them carefully before submitting:

  • Ensure that your code conforms to the project's code specifications. This includes but is not limited to code style, comment specifications, etc. This helps us to maintain the cleanliness and consistency of the project.
  • Before submitting a PR, please make sure that you have tested your code locally. Ensure that the code has no obvious errors and can run normally.
  • Please select appropriate labels for your PR. This helps us to process your PR more quickly.
  • Ensure that your PR title is concise and accurately summarizes your changes. Avoid using vague words such as "update" or "modify".
  • In the PR description, please provide a detailed description of your changes. This includes but is not limited to the following:
    • Reason for modification: briefly explain why this modification is necessary.
    • Modification content: describe in detail what you have modified and how you have implemented it.
    • Scope of impact: describe the functions or modules that may be affected by the modification.
    • Testing: describe the testing you have done locally and the results.
  • If your PR resolves a certain issue, please associate the corresponding issue in the PR description. For example: Fixes #123.

Communication and Consultation

We welcome you to participate in the project's communication and consultation.

You can interact with us through the following channels:

  • Submit your questions or suggestions in the project's discussions.
  • Join our technical communication group.

如何作出贡献

首先，感谢您对本开源项目的关注和支持！

我们非常欢迎和感谢任何形式的贡献，包括但不限于提交问题、提出改进意见、完善文档、修复缺陷以及新增功能。

本文档旨在为您提供一份详尽的贡献指南，以便您更好地参与到项目中。

请在参与贡献之前仔细阅读本指南，并确保遵循其中的规则和建议。

我们期待与您一起打造一个更加完善的开源项目！

提交 issue 的规则

在提交 issue 之前，请先确保您已经查看了项目的文档、常见问题解答以及已有的 issue。

这样可以避免重复提交已知问题，节省您和项目维护者的时间。

当您确定需要提交一个 issue 时，请遵循以下规则：

  • 为 issue 选择合适的标签。这有助于我们更快地找到问题所在，以便尽快解决。
  • 请确保您的 issue 标题简洁明了，能够准确概括问题所在。避免使用模糊的词语，如“问题”、“错误”等。

在 issue 描述中，请详细说明您遇到的问题。

包括但不限于以下内容：

  • 问题描述：简要说明问题的现象和影响。
  • 复现步骤：详细描述如何复现问题，让我们能够更快地定位和解决问题。
  • 环境信息：包括操作系统、浏览器、项目版本等相关信息。
  • 错误日志：如果有相关错误日志，请一并提供。
  • 期望结果：描述您期望的正确结果是什么。
  • 截图或录屏：如果可能，请提供问题现象的截图或录屏。

请保持礼貌和友好。我们非常重视项目的氛围，希望每个人都能够在友好、包容的环境中共同成长。

提交 PR 的规则

我们非常欢迎您为项目提交代码。

在提交 PR 之前，请确保您已经阅读了项目的文档以及本贡献指南。

以下是关于提交 PR 的一些建议和规则，请在提交前仔细阅读：

  • 请确保您的代码符合项目的代码规范。这包括但不限于代码风格、注释规范等。这有助于我们保持项目的整洁和一致性。
  • 在提交 PR 之前，请确保您已经在本地测试过您的代码。确保代码没有明显的错误，并能够正常运行。
  • 请为您的 PR 选择合适的标签。这有助于我们更快地处理您的 PR。
  • 请确保您的 PR 标题简洁明了，能够准确概括您的修改。避免使用模糊的词语，如“更新”、“修改”等。
  • 在 PR 描述中，请详细说明您的修改内容。包括但不限于以下内容：
    • 修改原因：简要说明为什么要进行这次修改。
    • 修改内容：详细描述您修改了哪些内容，以及修改的具体实现。
    • 影响范围：说明修改可能影响到的功能或模块。
    • 测试情况：描述您在本地测试的情况，以及测试结果。
  • 如果您的 PR 解决了某个 issue，请在 PR 描述中关联对应的 issue。例如：Fixes #123。

技术交流与问题咨询

我们非常欢迎您参与到项目的技术交流和问题咨询中来。

您可以通过以下途径与我们互动：

  • 在项目的 discussions 中提交您的问题或建议
  • 加入我们的技术交流群