Table of Contents
- How to Apply for Being A Collaborator
- Advice for Collaborator
- Feel free to answer and close issues
- Feel free to apply labels to issues and PRs
- Try to answer questions in issues & Stack Overflow & Segment Fault & Gitter
- Feel free to update wikis
- Feel free to merge PRs, such as...
- Feel free to create a PR to ...
- Try not to push to master and stable branch directly
- Certificate
- Retirement
- 如何申请成为协作者
- 对协作者的建议
- 随时回答和关闭问题
- 随时为问题和 PR 添加标签
- 尽量回答 issues & Stack Overflow & Segment Fault & Gitter 中的问题
- 随时更新维基
- 随时合并 PR,比如...
- 随时创建 PR 来...
- 尽量不要直接推送到 master 和稳定分支
- 证书
- 退休
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
How to Apply for Being A Collaborator
If you had contributed to Ant Design for a long time, and you are going to contribute. You can comment in #3222, then the community will thumbs up or thumbs down. If many people think that you will be a good collaborator, we will add you to the collaborators list.
Advice for Collaborator
After you being a collaborator of Ant Design, you will get some permissions, but we recommend you to follow the following advice for a better Ant Design.
Feel free to answer and close issues
We encourage you to answer, resolve and close daily issues, help more people to use antd
in correct way.
Feel free to apply labels to issues and PRs
We encourage you to apply suitable labels to them, for labels will make them easier to manage. And here is a long list of labels that we can use in ant-design.
e.g.
- Someone report a bug, and you had re-produced it locally. Just apply
Bug
to it. - Someone create an issue, and you remember that there is an similar existing issue. Just comment the existing issue's link in this duplicated issue and apply
Duplicate
to it.
Try to answer questions in issues & Stack Overflow & Segment Fault & Gitter
Though antd
was published in 2015, it is still a new thing for many developers. Ant Design team has tried to answer every question which is asked by developers. But it will be better that all the collaborators can help those new comers.
Feel free to update wikis
We already had some wikis, but there are not perfect. And you can improve them anytime, especially for Cookbook and FAQ.
Feel free to merge PRs, such as...
- PR which is to improve documentation.
- PR which is to improve code style.
- PR which is to fix bug, make sure that CI is success and test it locally.
If a PR is to add feature or you are not sure if it should be merged/closed, you can comment with +1
or -1
.
Feel free to create a PR to ...
You may need to read the development guide and CONTRIBUTING.md first.
Try not to push to master
and stable branch directly
If you want to add feature for latest version(master
) or fix bug in stable version([version]-stable
), you can create a pull request. And we hope that you can follow tips about pull request.
But you can create/delete your own branch on ant-design anytime, if you don't want to fork it.
Improve code style
antd
is developed by many people in a short time at the very beginning. So, the code style is a little... You can improve them any time. But please follow lint rules and code convention.
Improve Documentation and Demo
Any improvement is welcomed, such as:
- Make documentation more fluently/concisely in language.
- Make a demo more meaningful and useful in real world.
- Fix typos
- ...
Maybe you need to read the configuration guide first.
Fix bug of antd
If a bug report is confirmed, it will/should be tagged with Bug
. If you think that you can fix this bug. Just comment in this issue and the maintainer will assign/re-assign it to you.
Add feature to antd
Here is a list of features that had been accepted by Ant Design team. If you want to implement any of them, just comment in relative issue and the maintainer will assign/re-assign it to you.
Certificate
Ant Design provides certificate for core contributor. The certificate requires (one of the rule match):
- Collaborator
- Key feature confirmed by social
Retirement
Long time unreachable
It has potential security risk for long time unreachable account. We will move inactive collaborators from @ant-design/ant-design-collaborators
team to @ant-design/ant-design-collaborators-retirement
team. These team will have less permissions for the repo.
And @ant-design/ant-design-collaborators-retirement
will be cleaned regularly.
Remove yourself from collaborators list
If you no longer want to be a collaborator on ant-design, you can remove yourself.
如何申请成为协作者
如果你长期为 Ant Design 做贡献,并且打算继续贡献,你可以在 #3222 中发表评论,然后社区将会对你进行点赞或点踩。如果很多人认为你会是一个好的协作者,我们将会把你加入协作者列表。
对协作者的建议
在你成为 Ant Design 的协作者之后,你将获得一些权限,但我们建议你遵循以下建议,以更好地为 Ant Design 服务。
随时回答和关闭问题
我们鼓励你回答、解决和关闭日常问题,帮助更多的人正确使用 antd
。
随时为问题和 PR 添加标签
我们鼓励你为问题和 PR 添加合适的标签,这将使管理它们更容易。这里有一个我们可以在 ant-design 中使用的标签列表。
例如:
- 有人报告了一个 bug,并且你在本地重现了它。只需为其添加
Bug
标签。 - 有人创建了一个问题,并且你记得有一个类似的现有问题。只需在这个重复的问题中评论现有问题的链接并添加
Duplicate
标签。
尽量回答 issues & Stack Overflow & Segment Fault & Gitter 中的问题
虽然 antd
于 2015 年发布,但对于许多开发者来说,它仍然是一个新事物。Ant Design 团队试图回答开发者提出的每一个问题。但如果所有协作者都能帮助这些新手,将会更好。
随时更新维基
我们已经有了一些维基,但它们并不完美。你可以随时改进它们,特别是 Cookbook 和 FAQ。
随时合并 PR,比如...
- 改进文档的 PR。
- 改进代码风格的 PR。
- 修复 bug 的 PR,请确保 CI 成功并在本地测试。
如果一个 PR 是添加功能或者你不确定它是否应该被合并/关闭,你可以评论 +1
或 -1
。
随时创建 PR 来...
你可能需要先阅读开发指南和 CONTRIBUTING.md。
尽量不要直接推送到 master
和稳定分支
如果你想为最新版本(master
)添加功能或修复稳定版本中的 bug([version]-stable
),你可以创建一个 pull request。我们希望你能遵循关于 pull request 的提示。
但如果你不想 fork 仓库,你可以随时在 ant-design 上创建/删除你自己的分支。
改进代码风格
antd
是在最初的短时间内由许多人开发的。所以,代码风格有点... 你可以随时改进它们。但请遵循 lint 规则和代码约定。
改进文档和示例
任何改进都是受欢迎的,例如:
- 使文档语言更加流畅/简洁。
- 使示例在实际应用中更有意义和实用。
- 修正拼写错误
- ...
也许你需要先阅读文档和示例的配置指南。
修复 antd
的 bug
如果一个 bug 报告已确认,它将/应该被标记为 Bug
。如果你认为你能修复这个 bug,只需在这个问题中评论,维护者将分配/重新分配给你。
为 antd
添加功能
这里有一个 已被 Ant Design 团队接受的功能列表。如果你想实现其中任何一个,只需在相关问题中评论,维护者将分配/重新分配给你。
证书
Ant Design 为核心贡献者提供证书。证书的要求(满足以下任一规则):
- 协作者
- 通过社交确认的关键功能
退休
长时间无法联系
长时间无法联系的账户有潜在的安全风险。我们将把不活跃的协作者从 @ant-design/ant-design-collaborators
团队移动到 @ant-design/ant-design-collaborators-retirement
团队。这个团队将拥有更少的权限。
@ant-design/ant-design-collaborators-retirement
将定期清理。
从协作者列表中删除自己
如果你不再想成为 ant-design 的协作者,你可以删除自己。
- Home
- Cookbook
- FAQ
- Template for Bug Report in IE8 9
- Contributing
- Maintaining
- Design