Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (45 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 3.47 KB

如何贡献

您可以通过以下两种主要方式来贡献.

There are two main ways you can contribute.

方式一：通过 GitHub Issue 快速提交

如果您想快速分享一个案例，或者不太熟悉 Pull Request 流程，可以通过 Issue 提交。我们将在案例

➡️ 点击这里使用模板提交新案例：提交新案例

Option 1: Quick Submit via GitHub Issue

If you want to quickly share an example, or if you're less familiar with the Pull Request process, submitting via an Issue is a great option.

➡️ Click here to submit a new example using the template: Submit New Example

方式二：通过 Pull Request (PR) 贡献

  1. Clone仓库并在创建本地分支

  2. 添加新案例：

  • 请参考我们的 案例模板 来准备内容。
  • 准备图片文件：
    • 请为图片起一个描述性强且不易重复的文件名（例如：q-version-matryoshka-dolls.jpeg）。
    • 将图片文件放置在项目根目录下的 ./examples/ 文件夹内。
    • 图片要求： 建议宽度在 300px 到 2000px 之间；推荐使用 JPEG、WebP 或 PNG 格式；文件大小请尽量控制在 1MB 以内（如需，请先进行压缩）。
  • 编写案例 Markdown：
    • 根据案例模板的要求，填写或修改案例的详细信息。
    • 确保在 Markdown 中正确引用了您的图片文件名。
    • 请务必提供案例的 原文链接 (Source URL) 和 原作者链接/用户名 (Author)。
    • 语言： 您只需将案例添加到 一个 README 文件中即可（中文 README.md 或 英文 README_en.md）。维护者在合并时会负责同步到另一个语言版本。
    • 案例编号： 您无需指定案例编号，将由维护者在合并时统一分配和排序。

  1. 提交更改并在 GitHub 发起 Pull Request。

  2. 等待维护者进行审查和合并

Option 2: Contribute via Pull Request (PR)

  1. Clone the repository and create a local branch

  2. Add New Example:

  • Please refer to our Example Template to prepare the content.
  • Prepare the Image File:
    • Please use a descriptive and unique filename for the image (e.g., q-version-matryoshka-dolls.jpeg).
    • Place the image file in the ./examples/ directory at the project root.
    • Image Requirements: Recommended width between 300px and 2000px; recommended formats are JPEG, WebP, or PNG; please try to keep the file size under 1MB (compress if necessary).
  • Write the Example Markdown:
    • Fill out or modify the example details according to the template requirements.
    • Ensure you correctly reference your image filename in the Markdown.
    • Please be sure to provide the Source URL and the Original Author link/username.
    • Language: You only need to add the example to one README file (Chinese README.md or English README_en.md). Maintainers will handle syncing it to the other language version upon merging.
    • Case Number: You do not need to assign a case number; maintainers will assign and sort them when merging.

  1. Commit changes and create a Pull Request on GitHub.

  2. Wait for maintainers to review and merge

感谢你您的贡献！

Thank you for your contribution!