贡献
这里有一些Grunt项目
- grunt - Grunt主项目
- grunt-init - 独立的grunt项目脚手架工具
- gruntjs.com - gruntjs官方网站
- grunt-contrib collection - Grunt’contrib’插件集合
此外,每个单独的grunt-contrib插件都有一个独立的仓库,并且已经列在gruntjs主页上了。
想要做出贡献?
如果你想要为项目做出贡献,但是又不知道从何处开始,这是一些给你的建议。以下链接给出的问题被标记为高需求级,这意味着需要一个pull request来修复它们。选择它们中的一个开始。如果你正在处理某个问题,请确保你在问题后留言。
- grunt-init - Contribution guidelines should go into contributing.md
- grunt-init-gruntfile - Doesn’t generate a package.json
- grunt-contrib-coffee - Support the process option
- grunt - —gruntfile parameter broken with parent directories
- grunt-contrib-compress - Add bzip2 support
- grunt-contrib-jasmine - Enhance logging
问题反馈
如果有些事情不是像你想象的那样工作的,请阅读文档,尤其是新手入门指南。如果你想和别人聊聊grunt,请加入到grunt社区IRC并提出你的问题。
如果你有一些问题并没有在这个文档中涵盖或者希望申报一个bug,适当的跟踪有问题的文件是确保问题得以解决的最好的方式。
- 如果有一些grut, grunt-init, grunt-lib-???模块的问题,或者是特定的grunt-contrib-???插件相关的的问题
- 请在Grunt项目的问题跟踪站点提交问题文件。
- 如果你愿意给一个新的插件做贡献。
- 请提交问题文件到grunt-contrib问题跟踪集合站点中。虽然我们不会接受所有的插件,但我们会考虑你的意见。
- 如果发现官方网站有问题
- 请提交到Grunt官网问题跟踪集合站点中。
- 如果遇到以上描述之外的问题
- 请提交问题文件到grunt问题跟踪站点中并让我们知道你为什么提交它。
简化问题
尽量减少你的代码到最少以保证重现该问题,这使得它更容易(及早)避免或者更容易解决问题。
解释问题
如果不能重现问题,我们就不能及时解决它。请列出重现该问题的步骤,包括你的系统版本,Node.js版本,grunt版本等等,最好包括相关的日志或示例代码。
Grunt讨论
加入freenode IRC的#grunt频道,那里有一个机器人和所有信息。
请不要发私人的信息。
修改grunt
- 确保安装了grunt-cli(查看入门指南可以获取更多信息)。
- Fork和clone我们的Grunt仓库。
- 检出master分支(多数的grunt/grunt-contrib开发都是在这里完成的)。
- 运行
npm install
安装所有的Grunt依赖。 - 运行
grunt
来构建Grunt项目。
假设你没有看到标红的部分,那说明你准备好了。在所有更改完成之后运行grunt
,以确保不会被中断。
提交pull requests
- 创建一个新的分支,请不要直接在
master
上工作。 - 给你想要的改变添加失败测试,运行
grunt
查看失败测试。 - 解决问题。
- 运行
grunt
查看它是否通过测试。如果没有,请重复2-4步骤直到它通过。 - 更新文档以反应相关变化。
- 推送到你的分支并提交pull request。
语法
- 使用两个空格缩进而不要随意的位置使用tab缩进,如果字符串中需要使用tab字符则使用
\t
来替代。 - 不要使用多余的空格,除了在markdown文件必须使用它来强制换行。
- 不要极端的使用空格。
- 不要每一个变量都使用
var
语句赋值。 - 使用单引号
'
分割字符串而不是双引号"
。 - 提出
if
和else
语句,使用灵活的? :
控制流程语句或者||
,&&
等逻辑运算符。 - 注释是很有用的,应该将他们放在代码的前面,而不是代码的后面。
- 如果还有疑问,请在你的源代码中遵循上面你看到的规则。
中文社区贡献说明:" class="reference-link">中文社区贡献说明:
首先可以clone我们的master分支(因为我们的markdown源文件在这个分支中)到你的本地工作目录中,然后作出修改;完成修改之后可以给我们提交pull request。
gh-pages分支中的HTML会根据源码自动编译发布,如果有修改请参考上一条。
如果有相关问题可以加入我们的QQ群,或者在github的issue中提出来。
文档编辑使用中文标点,对列数暂不作限制。