Merge branch 'omorillo-improve-contribution-section-in-readme'
This commit is contained in:
commit
9f122c8873
26
README.md
26
README.md
|
@ -138,11 +138,23 @@ Help Needed
|
||||||
* `?token=XYZ` - Can not find a way to include a token parameter on an AbstractProject to security check without an extra plugin configuration
|
* `?token=XYZ` - Can not find a way to include a token parameter on an AbstractProject to security check without an extra plugin configuration
|
||||||
* `/PROJECT_NAME/` should really be /PROJECT_ID_NUMBER/ - Can not find a project id number on an AbstractProject to use here instead.
|
* `/PROJECT_NAME/` should really be /PROJECT_ID_NUMBER/ - Can not find a project id number on an AbstractProject to use here instead.
|
||||||
|
|
||||||
Contributing
|
Contributing to the Plugin
|
||||||
=====================
|
==========================
|
||||||
|
|
||||||
1. Fork it ( https://github.com/[my-github-username]/gitlab-plugin/fork )
|
Plugin source code is hosted on [Github](https://github.com/jenkinsci/gitlab-plugin).
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
New feature proposals and bug fix proposals should be submitted as
|
||||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
[Github pull requests](https://help.github.com/articles/creating-a-pull-request).
|
||||||
4. Push to the branch (`git push origin my-new-feature`)
|
Fork the repository on Github, prepare your change on your forked
|
||||||
5. Create a new Pull Request
|
copy, and submit a pull request (see [here](https://github.com/jenkinsci/gitlab-plugin/pulls) for open pull requests). Your pull request will be evaluated by the [Cloudbees Jenkins job](https://jenkins.ci.cloudbees.com/job/plugins/job/gitlab-plugin/).
|
||||||
|
|
||||||
|
If you are adding new features please make sure that they support the Jenkins Workflow Plugin.
|
||||||
|
See [here](https://github.com/jenkinsci/workflow-plugin/blob/master/COMPATIBILITY.md) for some information.
|
||||||
|
|
||||||
|
Before submitting your change make sure that:
|
||||||
|
* new features are provided with tests
|
||||||
|
* refactored code is provided with regression tests
|
||||||
|
* the code formatting follows the plugin standard
|
||||||
|
* imports are organised
|
||||||
|
* you updated the help docs
|
||||||
|
* you updated the README
|
||||||
|
* you have used findbugs to see if you haven't introduced any new warnings.
|
||||||
|
|
Loading…
Reference in New Issue