Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add CONTRIBUTING.md #44

Merged
merged 1 commit into from
Mar 26, 2017
Merged

Add CONTRIBUTING.md #44

merged 1 commit into from
Mar 26, 2017
+84 −1

Conversation

zhsj
Copy link
Contributor

@zhsj zhsj commented Mar 24, 2017

address #40

@zhsj zhsj force-pushed the wip-add-contributing-md branch 4 times, most recently from 39c1944 to 3ba106b Compare March 24, 2017 18:00
knight42
knight42 requested changes Mar 24, 2017
View reviewed changes
CONTRIBUTING.md Outdated

* reStructureText syntax

Make sure `sphinx-build` run without warnings.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

现在我已经在 Makefile 里强制把 warning 当成 error, 我觉得可以提及一下构建方式: make html

CONTRIBUTING.md Outdated

* reStructureText syntax

Make sure `sphinx-build` run without warnings.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

另外, 关于一些规定, 比方说要在 index.rst 中加入新增文档的文件名, 我觉得也有必要提及一下

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

没有在 index.rst 中加文件名的话，sphinx-build 会有 warning。。

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

唔.. 我觉得之前没接触过的话, 以下错误可能不太直观, 比方说刚刚的 pr #43

pickling environment... done

checking consistency... 

Warning, treated as error:

/home/travis/build/ustclug/mirrorhelp/source/docker-ce.rst:: WARNING: document isn't included in any toctree

make: *** [html] Error 1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

其实确实没必要放到 index.rst，万一以后 index.rst 里文件列表太长了，我们把它拆成了几个文件呢。。
只要文件能被索引进 toctree 里就可以了。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

我觉得可以加一段常见 sphinx 错误的解释。。。

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

但现在只有加进 index.rst 才能被索引吧... 未来情况有变的话, 再更新就是了.

@gaoyifan
Copy link
Member

是否考虑使用中文撰写CONTRIBUTING.md? @zhsj
一来降低门槛（比如部分用户只想提交issue，为此读一大段英文容易增加畏难情绪），二来文档内容都是中文的，CONTRIBUTING.md反而用英文显得有些不自然。

@zhsj zhsj force-pushed the wip-add-contributing-md branch 2 times, most recently from b27fbc5 to 6550300 Compare March 26, 2017 08:49
@knight42
Copy link
Member

@zhsj 还需要做其他改动吗? 如果没有的话我就 merge 了.

@zhsj zhsj merged commit abe2453 into master Mar 26, 2017
@zhsj zhsj deleted the wip-add-contributing-md branch March 27, 2017 02:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@knight42 knight42 knight42 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@zhsj @gaoyifan @knight42