Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

95 lines (65 loc) · 3.43 KB
Raw

Contributing

Table of Contents

Never report security issues on GitHub, public Jira issues or other public channels (Gitter/Twitter/etc.), follow the instruction from Jenkins Security to report it on Jenkins Jira

In the Jenkins project we appreciate any kind of contributions: code, documentation, design, etc. Any contribution counts, and the size does not matter! Check out this page for more information and links!

Many plugins and components also define their own contributing guidelines and communication channels. There is also a big number of mailing lists and chats.

NOTE: This is a default CONTRIBUTING page for all repositories in Jenkins. Every plugin/component is its own sub-project which may deviate in its rules. Guidelines and channel links in repository CONTRIBUTING/README pages, if any, take precedence over this page.

Newcomers

If you are a newcomer contributor and have any questions, please do not hesitate to ask in the Newcomers Gitter channel.

Useful links

Source code contribution ways of working

  • For larger contributions create an issue for any required discussion
  • Implement solution on a branch in your fork
  • Make sure to include issue ID (if created) in commit message, and make the message speak for itself
  • Once you're done create a pull request and ask at least one of the maintainers for review
    • Remember to title your pull request properly as it is used for release notes

Run Locally

Prerequisites: Java and Maven, (some plugins use Gradle, you will just need Java if you're building a Gradle plugin).

  • Ensure Java 8 or 11 is available.

    $ java -version
    • Use the alternate Java 8.
    $ export JAVA_HOME=`/usr/libexec/java_home -v 1.8`	
$ echo $JAVA_HOME	
/Library/Java/JavaVirtualMachines/jdk1.8.0_252.jdk/Contents/Home

  • Ensure Maven > 3.6.0 is installed and included in the PATH environment variable.

    $ mvn --version

IDE configuration

See IDE configuration

CLI

  • Use the below commands.
$ mvn hpi:run	
...	
INFO: Jenkins is fully up and running

Some plugins use multi module maven builds and you may need to change your hpi:run command to be run from the child directory, and build the other modules first.

$ mvn install -P quick-build
$ mvn -f plugin hpi:run