Appearance
贡献指南
¥Contribution Guide
无论贡献大小,我们都欢迎你贡献代码!以下是一些关于如何参与 Rolldown 项目的通用指南。
¥Contributions are always welcome, no matter how large or small! Here we summarize some general guidelines on how you can get involved in the Rolldown project.
开放开发
¥Open development
所有开发都直接在 GitHub 上进行。核心团队成员和外部贡献者(通过 fork)都会发送拉取请求,这些请求会经过相同的审核流程。
¥All development happens directly on GitHub. Both core team members and external contributors (via forks) send pull requests which go through the same review process.
在 GitHub 之外,我们还使用 Discord 服务器 进行实时讨论。
¥Outside of GitHub, we also use a Discord server for real-time discussions.
报告错误
¥Reporting a bug
请仅在你之前搜索过该问题且未找到结果后,才将错误报告给 GitHub。请确保描述尽可能详细,并包含所有适用的标签。
¥Please report bugs to GitHub only after you have previously searched for the issue and found no results. Be sure to be as descriptive as possible and to include all applicable labels.
修复错误的最佳方法是提供精简的测试用例。请提供一个包含可运行示例或可用代码片段的公共仓库。将来,我们还将提供一个可在浏览器中运行的 REPL,以便于更轻松地进行复现。
¥The best way to get your bug fixed is to provide a reduced test case. Please provide a public repository with a runnable example, or a usable code snippet. In the future, we will also provide a REPL that runs in the browser for easier reproductions.
请求新功能
¥Requesting new functionality
在请求新功能之前,请查看 未解决的问题,因为你的请求可能已经存在。如果不存在,请提交标题为 [request] 前缀的问题。请确保描述尽可能详细,并包含所有适用的标签。
¥Before requesting new functionality, view open issues as your request may already exist. If it does not exist, submit an issue with the title prefixed with [request]. Be sure to be as descriptive as possible and to include all applicable labels.
提交拉取请求
¥Submitting a pull request
我们接受所有错误、修复、改进和新功能的拉取请求。在提交拉取请求之前,请确保你的构建已使用上述开发工作流程在本地通过。
¥We accept pull requests for all bugs, fixes, improvements, and new features. Before submitting a pull request, be sure your build passes locally using the development workflow above.
有关设置项目开发环境的信息,请参阅 项目设置。
¥For setting up the project's development environment, see Project Setup.
分支组织
¥Branch organization
所有拉取请求直接提交到 main 分支。我们只对即将发布的版本/重大变更使用单独的分支,否则所有内容都指向主分支。
¥Submit all pull requests directly to the main branch. We only use separate branches for upcoming releases / breaking changes, otherwise, everything points to main.
进入主函数的代码必须与最新的稳定版本兼容。它可能包含其他功能,但不包含重大更改。我们应该能够随时从 main 的提示发布新的次要版本。
¥Code that lands in main must be compatible with the latest stable release. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of main at any time.