贡献,并且帮助我们改进
呼吁翻译! 我们正在寻找翻译为所有人做这个规范。
帮助改进all-contributors文档
感谢您参与该项目! 欢迎任何微如拼写错误、大到添加章节帮助我们提高项目的 Pull Requests.
源代码可在 github.com/all-contributors/all-contributors 中查看。
向 all-contributors 仓库提交 commit
We use the angular commit convention for commits that are used for an automated changelog generation, so it would be advisable to respect that. If you're not used to it or are afraid to mistype a commit, you can run npm run commit
or git cz
(if you have installed commitizen
) which would take you through a few questions and write the commit for you.
编辑内容
专业提示:每个页面在顶部都有一个编辑按钮,点击此按钮会直接指向此页面的GitHub源代码。
进入文件后,点击“铅笔”图标可以在文件中轻松编辑。
翻译
我们的翻译是通过crowdin管理。 您可以通过访问这个 crowdin 项目 ,并帮助翻译来做出您的贡献。 如果有需要,评论这个 issue ,让我们知道你在帮助我们或有任何疑问!
When translating, anything that has the XPATH
@href
,@src
etc mustn't be translated. 像code
这样的也不应该翻译。 对于链接,这将导致 404 错误。 See the below image for an example:然而,我们也推荐贡献有助于让人理解
code
标记的翻译, 只要 它没有变更到实际的任何代码,并只会以自然语言的方式理解。
怎样做
登录 Crowdin
- 请前往 Crowdin 项目页,随后注册 并/或登录。
- 加入 “All Contributors” 项目并发声吧!
翻译文档
- 访问 这个 Crowdin 项目。
- 点击您想翻译文档至的语言旗帜。
- 点击任何
*.md
类型的未完成翻译的文件 (翻译完右侧会显示 100%) - 在"Enter translation here" 文本域中写上您的翻译 (这个这本域中的内容会对应到上面的"SOURCE STRING" 文本域) 然后点击 "SAVE" 保存翻译。
- 仅对于 校对者 : 您可以在 "[LANGUAGE] TRANSLATIONS"中通过点击:ballot_box_with_check:批准翻译建议 (无论是由您或其他人完成), 或通过点击:wastebasket:删除他们。
部署变更
After you translate strings in any given language, you won't see those changes appearing live until the master
branch was updated followed by a successful deployment.
搜索
Search is by algolia, the configuration is at https://github.com/algolia/docsearch-configs/blob/master/configs/all-contributors.json
在本地计算机运行本网站:
All Contributors 使用 Docusaurus 维护文档网站。 详情访问 Docurus 网站
在本地运行:
yarn install
yarn run start
- 打开 http://localhost:3000 (刷新以使更改生效)
添加你自己为 Contributor
为了添加自己到贡献者表, 查看机器人使用指令 ;)。