From the GitHub Manual of Style, which this style guide inherits from:
Words are an important part of how software works. Just as we have a style guide for our code, we have a style guide for our tone and our voice. Even though there may be dozens of people creating a product, it should still sound like we speak in one consistent voice.
In other words, the way we write is just as important as the way we design. Consider these things when writing copy.
Where possible, automated tests enforce style rules.
All written content should follow these principles:
Content should maintain a light-hearted, but wise (think classy, not overly excited) tone. Open source is fun! Readers should feel inspired, not discouraged, by the tone of your writing, and they should trust you to help them get started.
When referring to people that use GitHub, use @mentions of their username instead of their full name.
When referring to a project on GitHub, link to the repository so others can dive deeper, if they choose.
"Guides" is capitalized when referring to the "Open Source Guides", but not when saying "the guide" or "this guide".
Understand our content model and audience
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。