Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Jenkins 中文社区
jenkins-cli
提交
922bff06
J
jenkins-cli
项目概览
Jenkins 中文社区
/
jenkins-cli
通知
49
Star
8
Fork
1
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
J
jenkins-cli
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
922bff06
编写于
9月 18, 2019
作者:
LinuxSuRen
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Add contribution guide
上级
99c8fa77
变更
3
显示空白变更内容
内联
并排
Showing
3 changed file
with
54 addition
and
2 deletion
+54
-2
CONTRIBUTING.md
CONTRIBUTING.md
+51
-0
README-zh.md
README-zh.md
+1
-1
README.md
README.md
+2
-1
未找到文件。
CONTRIBUTING.md
0 → 100644
浏览文件 @
922bff06
Welcome! Any kinds of contributions are very welcomed. Please go through our contribution
guide before you try to create a Pull Request for
`jcli`
.
## CLI
`jcli`
is a command line interface. So a CLI framework is super important for us. Thanks to
[
cobra
](
https://github.com/spf13/cobra
)
. It powers us to do a better job.
## Jenkins API
API is another important part of this project.
`jcli`
manages your Jenkins by the HTTP API.
There's no official documents for this. You can figure it by yourself, or just join our
[
gitter room
](
https://gitter.im/jenkinsci/jenkins-cli
)
.
## Testing
We use a BDD Testing Framework to test our project. Please make sure you're familar
with
[
ginkgo
](
https://github.com/onsi/ginkgo
)
before you get start to contribute.
## Pull Requests
Before you get start, please fork this project into your GitHub account firstly. Then
create a git branch base on what you want to improve. Please consider
**never**
using
the master branch as your develope branch. And the behaviour of the git
**force push**
is not
encourage.
Please
**don't**
create another Pull Request if you messed up your git commit records.
In order to generate a nice
[
release notes
](
https://github.com/jenkins-zh/jenkins-cli/releases
)
,
please consider writing a proper Pull Request title.
[
release-draft
](
https://github.com/toolmantim/release-drafter
)
will generate the notes base your title.
## Qulity
Qulity is the heart of a project. So please make sure your Pull Request could pass the
[
Sonar Qulity Gate
](
https://sonarcloud.io/dashboard?id=jenkins-zh_jenkins-cli
)
.
|Metric|Operator|Value|
|---|---|---|
|Coverage|is less than|90.0%|
|Duplicated Lines(%)|is greater than|3.0%|
|Maintainablity Rating|is worse than|A|
|Blocker Issues|is greater than|1|
|Code Smells|is greater than|1|
|Reliablity Rating|is worse than|A|
|Security Rating|is worse than|A|
## Good Start
The
[
newbie
](
https://github.com/jenkins-zh/jenkins-cli/issues?q=is%3Aissue+is%3Aopen+label%3Anewbie
)
issues
are the good start.
README-zh.md
浏览文件 @
922bff06
...
@@ -55,4 +55,4 @@ sudo mv jcli /usr/local/bin/
...
@@ -55,4 +55,4 @@ sudo mv jcli /usr/local/bin/
# 贡献
# 贡献
该工具还处在非常早期的开发阶段,
我们欢迎任何形式的贡献。
如果你对该项目感兴趣,请首先仔细阅读我们的
[
贡献指南
](
CONTRIBUTING.md
)
。
我们欢迎任何形式的贡献。
README.md
浏览文件 @
922bff06
...
@@ -56,4 +56,5 @@ Read [this document](doc/README.md) to know more details about how to use `jcli`
...
@@ -56,4 +56,5 @@ Read [this document](doc/README.md) to know more details about how to use `jcli`
# Contribution
# Contribution
It's still under very early develope time. Any contribution is welcome.
If you're interested in this project. Please go through the
[
contribution guide
](
CONTRIBUTING.md
)
. Any contributions are welcome.
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录