mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-02 01:22:49 +02:00
Yun chinese translation (#43)
* translate bot.md to Chinese * translate Hackthon.md to Chinese * translate CHANGELOG.md to Chinese * translate:CODE_OF_CONDUCT.md to Chinese * translate:CONTRIBUTING.md to Chinese * translate:PULL_REQUEST_TEMPLATE.md to Chinese
This commit is contained in:
Yun Ji
GitHub
@@ -0,0 +1,48 @@
|
||||
# 变更日志
|
||||
该项目的显著变更都将记录在该文档中。
|
||||
|
||||
格式遵照 [Keep a Changelog](http://keepachangelog.com/)
|
||||
该项目遵循 [Semantic Versioning](http://semver.org/).
|
||||
|
||||
## [尚未发布] - yyyy-mm-dd
|
||||
|
||||
在此我们为品牌写升级说明。此处为团队合作，尽量使说明简单明了。
|
||||
|
||||
### 新增
|
||||
- [项目名称-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX)
|
||||
MINOR Ticket title goes here.
|
||||
- [项目名称-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY)
|
||||
PATCH Ticket title goes here.
|
||||
|
||||
### 更改
|
||||
|
||||
### 修复
|
||||
|
||||
## [1.2.4] - 2017-03-15
|
||||
|
||||
此处我们可以提供1.2.4的更新步骤供大家参考。
|
||||
|
||||
### 新增
|
||||
|
||||
### 更改
|
||||
|
||||
- [项目名称-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ)
|
||||
现在 PATCH Drupal.org 用于创作人。
|
||||
|
||||
### 修复
|
||||
|
||||
- [项目名称-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT)
|
||||
PATCH 为 runsheet teaser 删除添加逻辑，以删除相应的计划卡。
|
||||
|
||||
## [1.2.3] - 2017-03-14
|
||||
|
||||
### 新增
|
||||
|
||||
### 更改
|
||||
|
||||
### 修复
|
||||
|
||||
- [项目名称-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU)
|
||||
MINOR Fix module foo tests
|
||||
- [项目名称-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR)
|
||||
MAJOR Module foo's timeline uses the browser timezone for date resolution
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
# 参与者公约
|
||||
|
||||
|
||||
## 我们的承诺
|
||||
|
||||
为建设开放友好的环境，我们贡献者和维护者承诺：不论年龄、体型、身体健全与否、民族、性征、性别认同与表征、经验水平、教育程度、社会地位、国籍、相貌、种族、信仰、性取向，我们项目和社区的参与者皆免于骚扰。
|
||||
|
||||
## 我们的准则
|
||||
|
||||
有助于创造积极环境的行为包括但不限于：
|
||||
|
||||
* 措辞友好且包容
|
||||
* 尊重不同的观点和经验
|
||||
* 耐心接受有益批评
|
||||
* 关注对社区最有利的事情
|
||||
* 与社区其他成员友善相处
|
||||
|
||||
参与者不应采取的行为包括但不限于：
|
||||
|
||||
* 发布与性有关的言论或图像、不受欢迎地献殷勤
|
||||
* 捣乱/煽动/造谣行为、侮辱/贬损的评论、人身及政治攻击
|
||||
* 公开或私下骚扰
|
||||
* 未经明确授权便发布他人的资料，如住址、电子邮箱等
|
||||
* 其他有理由认定为违反职业操守的不当行为
|
||||
|
||||
## 我们的义务
|
||||
|
||||
项目维护者有义务诠释何谓“妥当行为”，并妥善公正地纠正已发生的不当行为。
|
||||
|
||||
项目维护者有权利和义务去删除、编辑、拒绝违背本行为标准的评论（comments）、提交（commits）、代码、wiki 编辑、问题（issues）等贡献；项目维护者可暂时或永久地封禁任何他们认为行为不当、威胁、冒犯、有害的参与者。
|
||||
|
||||
## 适用范围
|
||||
|
||||
本行为标准适用于本项目。当有人代表本项目或本社区时，本标准亦适用于此人所处的公共平台。
|
||||
|
||||
代表本项目或本社区的情形包括但不限于：使用项目的官方电子邮件、通过官方媒体账号发布消息、作为指定代表参与在线或线下活动等。
|
||||
|
||||
代表本项目的行为可由项目维护者进一步定义及解释。
|
||||
|
||||
## 贯彻落实
|
||||
|
||||
可以致信[在此输入EMAIL]，向项目团队举报滥用、骚扰及不当行为。
|
||||
|
||||
维护团队将审议并调查全部投诉，妥善地予以必要的回应。项目团队有义务保密举报者信息。具体执行方针或将另行发布。
|
||||
|
||||
未切实遵守或执行本行为标准的项目维护人员，经项目负责人或其他成员决议，可能被暂时或永久地剥夺参与本项目的资格。
|
||||
|
||||
## 来源
|
||||
|
||||
本行为标准改编自[参与者公约][主页]，版本 1.4
|
||||
可在此查阅：https://www.contributor-covenant.org/zh-cn/version/1/4/code-of-conduct.html
|
||||
|
||||
[主页]: https://www.contributor-covenant.org
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# 参与指南
|
||||
|
||||
- 参与 The Documentation Compendium 项目很简单，本文档教你快速上手。
|
||||
|
||||
## General
|
||||
- 请参照 [Codebase Structure](./CODEBASE_STRUCTURE.md) 了解本项目的文档结构。
|
||||
- 请确保你做的每一项更符合本 repo 的 [Coding Guidelines](./CODING_GUIDELINES.md)。
|
||||
## 提交更改
|
||||
|
||||
- Fork the repo
|
||||
- <https://github.com/kylelobo/The-Documentation-Compendium/fork>
|
||||
- Check out a new branch based and name it to what you intend to do:
|
||||
- Example:
|
||||
````
|
||||
$ git checkout -b BRANCH_NAME
|
||||
````
|
||||
If you get an error, you may need to fetch fooBar first by using
|
||||
````
|
||||
$ git remote update && git fetch
|
||||
````
|
||||
- Use one branch per fix / feature
|
||||
- Commit 你的更改
|
||||
- 请提供 git message 解释你做了什么
|
||||
- 请确保你的commit messages 遵循这一[conventions](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
|
||||
- Commit to the forked repository
|
||||
- 示例:
|
||||
````
|
||||
$ git commit -am 'Add some fooBar'
|
||||
````
|
||||
- Push to the branch
|
||||
- Example:
|
||||
````
|
||||
$ git push origin BRANCH_NAME
|
||||
````
|
||||
- Make a pull request
|
||||
- Make sure you send the PR to the <code>fooBar</code> branch
|
||||
- Travis CI is watching you!
|
||||
|
||||
如果你遵循以上步骤，你的PR将会顺利被合并到main repo 中。
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
### Pull request 检查清单
|
||||
🚨 请参照本repository [guidelines for contributing](./CONTRIBUTING.md).
|
||||
|
||||
- [ ] 请确保你从 **topic/feature/bugfix branch** (右手边)创建pull request. 请勿从master branch 创建pr.
|
||||
- [ ] 请确保你的pull request 针对 **fooBar branch** (左手边).
|
||||
- [ ] 检查commit 信息风格是否相符。
|
||||
- [ ] 你的代码能通过单元测试或代码提示检查。
|
||||
|
||||
### 描述
|
||||
请描述你的pull request.
|
||||
|
||||
❤️ 感谢!
|
||||
|
||||
@@ -0,0 +1,125 @@
|
||||
<p align="center">
|
||||
<a href="" rel="noopener">
|
||||
<img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a>
|
||||
</p>
|
||||
|
||||
<h3 align="center">机器人姓名</h3>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[]()
|
||||
[](https://www.reddit.com/user/Wordbook_Bot)
|
||||
[](https://github.com/kylelobo/The-Documentation-Compendium/issues)
|
||||
[](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
|
||||
[](/LICENSE)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<p align="center"> 🤖 用几句话描述你的机器人做什么<br>
|
||||
</p>
|
||||
|
||||
## 📝 目录
|
||||
+ [简介](#about)
|
||||
+ [演示](#demo)
|
||||
+ [原理](#working)
|
||||
+ [用法](#usage)
|
||||
+ [快速上手](#getting_started)
|
||||
+ [部署你的机器人](#deployment)
|
||||
+ [技术支持](#built_using)
|
||||
+ [待做](../TODO.md)
|
||||
+ [贡献](../CONTRIBUTING.md)
|
||||
+ [作者](#authors)
|
||||
+ [致谢](#acknowledgement)
|
||||
|
||||
## 🧐 简介 <a name = "about"></a>
|
||||
用 1-2 个段落描述该机器人的用途。
|
||||
|
||||
## 🎥 演示 <a name = "demo"></a>
|
||||
|
||||
|
||||
## 💭 原理 <a name = "working"></a>
|
||||
|
||||
|
||||
该机器人首先从评论中提取单词，然后从牛津词典 API 中获取单词的定义、语篇、例子和来源。如果该词在牛津词典中不存在，牛津词典的API 会返回一个 404 响应，机器人便会尝试从 Urban Dictionary 的 API 中获取结果。
|
||||
该机器人使用 Pushshift API 来获取评论，使用 PRAW 模块来回复评论，使用 Heroku 作为服务器。它用 Python 3.6 编写。
|
||||
|
||||
## 🎈 用法 <a name = "usage"></a>
|
||||
|
||||
使用该机器人，键入：
|
||||
```
|
||||
!dict word
|
||||
```
|
||||
指令的第一部分，如 "!dict" 对大小写**不**敏感。
|
||||
机器人会给你牛津词典（或 Urban Dictionary；如果该词不存在于牛津词典中）的定义作为评论回复。
|
||||
|
||||
### 示例:
|
||||
|
||||
> !dict what is love
|
||||
|
||||
**定义:**
|
||||
|
||||
Baby, dont hurt me~
|
||||
Dont hurt me~ no more.
|
||||
|
||||
**示例:**
|
||||
|
||||
Dude1: Bruh, what is love?
|
||||
Dude2: Baby, dont hurt me, dont hurt me- no more!
|
||||
Dude1: dafuq?
|
||||
|
||||
**来源:** https://www.urbandictionary.com/define.php?term=what%20is%20love
|
||||
|
||||
---
|
||||
|
||||
<sup>Beep boop. I am a bot. If there are any issues, contact my [Master](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot)</sup>
|
||||
|
||||
<sup>Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup>
|
||||
|
||||
## 🏁 快速上手 <a name = "getting_started"></a>
|
||||
|
||||
遵循以下指引，你将在本地机器上建立并运行项目副本用于开发和测试目的。参见[deployment](#deployment)了解如何在实时系统上部署项目的注意事项。
|
||||
|
||||
### 先决条件
|
||||
你需要哪些软件及如何安装它们。
|
||||
|
||||
```
|
||||
举个例子
|
||||
```
|
||||
|
||||
### 安装
|
||||
|
||||
手把手教你如何让运行开发环境。
|
||||
介绍每一步都是什么
|
||||
|
||||
```
|
||||
举个例子
|
||||
```
|
||||
|
||||
重复以上
|
||||
|
||||
```
|
||||
直到结束
|
||||
```
|
||||
|
||||
最后用从系统中获取的一些数据来举例，或者用它来做一个小演示。
|
||||
|
||||
## 🚀 部署你的机器人 <a name = "deployment"></a>
|
||||
|
||||
参见我的配置查看如何部署机器人的项目示例。
|
||||
+ **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
|
||||
|
||||
## ⛏️ 技术支持 <a name = "built_using"></a>
|
||||
+ [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper
|
||||
+ [Heroku](https://www.heroku.com/) - SaaS hosting platform
|
||||
|
||||
## ✍️ 作者 <a name = "authors"></a>
|
||||
+ [@kylelobo](https://github.com/kylelobo) - 构想&初步工作
|
||||
|
||||
另请参见参与本项目的[贡献者](https://github.com/kylelobo/The-Documentation-Compendium/contributors)名单。
|
||||
|
||||
## 🎉 致谢 <a name = "acknowledgement"></a>
|
||||
+ 向任何使用其代码的人致意
|
||||
+ 灵感来源
|
||||
+ 参考文献
|
||||
@@ -0,0 +1,101 @@
|
||||
<p align="center">
|
||||
<a href="" rel="noopener">
|
||||
<img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
|
||||
</p>
|
||||
<h3 align="center">项目标题</h3>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](http://hackathon.url.com)
|
||||
[]()
|
||||
[](https://github.com/kylelobo/The-Documentation-Compendium/issues)
|
||||
[](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
|
||||
[](LICENSE.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<p align="center"> 几句话描述你的项目
|
||||
<br>
|
||||
</p>
|
||||
|
||||
## 📝 目录
|
||||
- [问题陈述](#problem_statement)
|
||||
- [构想/解决方案](#idea)
|
||||
- [Dependencies / 限制因素](#limitations)
|
||||
- [今后工作范围](#future_scope)
|
||||
- [快速上手](#getting_started)
|
||||
- [用法](#usage)
|
||||
- [技术栈](#tech_stack)
|
||||
- [贡献](../CONTRIBUTING.md)
|
||||
- [作者](#authors)
|
||||
- [致谢](#acknowledgments)
|
||||
|
||||
## 🧐 问题陈述 <a name = "problem_statement"></a>
|
||||
在撰写问题陈述时，建议遵循特定设计范式。下面是一个商业分析领域常用的简明模板，旨在将焦点放在定义问题上。
|
||||
|
||||
- 理想状态：这一部分用来描述产品或程序的理想状态。总体而言，这一部分应说明一旦实施解决方案后的预期环境。
|
||||
- 现状：该部分用于描述程序或产品现状。
|
||||
- 后果：这一部分用来描述如果问题没有得到解决或改进，对企业的影响。这包括金钱、时间、生产力、竞争优势等成本。
|
||||
|
||||
遵循这一范式将产出一个可行文件，可以用来理解问题并引出需求，从而获得一个成功的解决方案。
|
||||
|
||||
## 💡 构想/解决方案 <a name = "idea"></a>
|
||||
本节用于描述潜在的解决方案。一旦完成并理解理想状态、现状和后果部分，提供解决方案就会更容易。
|
||||
|
||||
## ⛓️ Dependencies / 限制因素 <a name = "limitations"></a>
|
||||
- 你的项目有哪些dependencies？
|
||||
- 用详细简明的语言描述每个限制因素
|
||||
- 解释每个限制因素存在的原因
|
||||
- 解释为何所选择方法无法克服每个限制因素
|
||||
- 评估每个限制因素对你项目的整体结果和结论的影响。适当时，描述这些限制如何导向进一步研究的需要。
|
||||
|
||||
## 🚀 今后工作范围 <a name = "future_scope"></a>
|
||||
写下你在黑客马拉松中无法开发的内容，及你的项目在未来可以实现的目标。
|
||||
|
||||
## 🏁 快速上手 <a name = "getting_started"></a>
|
||||
遵循以下指引，你将在本地机器上建立并运行项目副本用于开发和测试目的。参见[deployment](#deployment)了解如何在实时系统上部署项目的注意事项。
|
||||
|
||||
### 先决条件
|
||||
你需要哪些软件及如何安装它们。
|
||||
|
||||
```
|
||||
举个例子
|
||||
```
|
||||
|
||||
### 安装
|
||||
|
||||
手把手教你如何让运行开发环境。
|
||||
介绍每一步都是什么
|
||||
|
||||
```
|
||||
举个例子
|
||||
```
|
||||
|
||||
重复以上
|
||||
|
||||
```
|
||||
直到结束
|
||||
```
|
||||
|
||||
|
||||
## 🎈 用法 <a name="usage"></a>
|
||||
添加关于如何使用该系统的说明。
|
||||
|
||||
|
||||
## ⛏️ 技术栈 <a name = "tech_stack"></a>
|
||||
- [MongoDB](https://www.mongodb.com/) - Database
|
||||
- [Express](https://expressjs.com/) - Server Framework
|
||||
- [VueJs](https://vuejs.org/) - Web Framework
|
||||
- [NodeJs](https://nodejs.org/en/) - Server Environment
|
||||
|
||||
## ✍️ 作者 <a name = "authors"></a>
|
||||
+ [@kylelobo](https://github.com/kylelobo) - 构想&初步工作
|
||||
|
||||
、、、、、、
|
||||
|
||||
## 🎉 致谢 <a name = "acknowledgement"></a>
|
||||
+ 向任何使用其代码的人致意
|
||||
+ 灵感来源
|
||||
+ 参考文献
|
||||
Reference in New Issue
Block a user