Documentation for JIRA 4.0. Documentation for other versions of JIRA is available too.

Skip to end of metadata
Go to start of metadata
Icon

Looking for plugins? To find existing plugins and extensions written by the community, visit the Atlassian Plugin Exchange and the JIRA Extensions space.

Icon

This documentation applies to JIRA 4.0. If you are developing a plugin for JIRA 3.x, please see the previous documentation.

Getting started developing with JIRA

So you're thinking of customizing JIRA? Maybe you want to change the way JIRA looks? Or create a new custom field type? Or add some new Workflow transitions? Well, you've come to the right place. Here are all the resources to get started developing for JIRA.

1. Getting started with Atlassian plugins

This tutorial​ will show you how to set up your development environment, create an empty plugin template, and the basic principles of building, debugging, and testing a plugin. It will take you through the prerequisites and introduce you to some of the resources that Atlassian provides for plugin developers.

2. The JIRA Plugin Guide

These documents are specifically about plugins for JIRA. There's a page for each plugin module type that JIRA supports. You can combine multiple plugin modules inside a single plugin to accomplish complex tasks.

3. Understanding how JIRA works

These documents go some of the way to explaining what's really going on inside JIRA. Some of this information is useful to plugin developers. Other pieces are more relevant to the JIRA development team, but we've published them here in the spirit of open documentation.

Want to modify the JIRA source code?

You'll want to download a copy of the source distribution and then follow the instructions in Building JIRA from source.

  1. Building JIRA from source
  2. Developer Tutorials

Help and documentation

Other resources for developers:

News and forums:

  • No labels