Before you start

We welcome contributions from anyone, but for the benefit of Jenkins users we ask that you look for plugins solving the same or similar problems to see whether you can join forces with existing maintainers. You can find an overview of existing plugins onhttps://plugins.jenkins.io. Feel free to ask on thejenkinsci-dev mailing listto see whether anyone is aware of another plugin implementing something similar to what you’re planning to do.

Make sure your plugin followsthe naming conventions.

All plugins distributed by the Jenkins project need to be free and open source software. This applies to the plugin source code as well as all its dependencies. Make sure to specify the license both in thepom.xmlfile, as well as aLICENSEfile in your repository.

We recommend use of the MIT license which is used for Jenkins core and most plugins and libraries, but any OSI-approved open source license will do.

We recommend that plugins include user documentation so users understand quickly what the plugin does and how to use it. We recommend following the documentation-as-code approach and keeping the documentation directly in the plugin repository.

SeeDocumentationfor more information.

Jenkins plugins distributed via Jenkins project update sites need to be hosted in thejenkinsci GitHub organization, so you will need a user account on GitHub.

To actually release your plugin, you will need aJenkins community accountthat will give you access to theissue trackerandMaven repository.