General Best Practices

The purpose of this document is to describe general best practices to follow while scripting.

Organizing Folders in the silprograms Directory

• Create a separate folder according to functionality

• Create a separate folder for each project

Development process

• Develop as much as possible from the SIL Manager. Developing from the SIL Manger tends to give the user a better sense of what the code does and is much faster.

• Start with one routine as a proof of concept.

• Add loops and if statements after.

• Hardcode at first to get a result.

• Refactor hardcoded values with with variables.

• If possible, test Live Fields in the edit screen before trying in Jira Service Desk portal or create screen. The JSD portal tends to be more complicated and more can go wrong.

Looking for Ideas

• Often other users have already done something similar to what you would like to do. Find an example on the Atlassian Community?

• Look for routines.

  • First look for routines in the Jira Integration Routines section of the documentation. Most routines dealing with Jira will be found here.

  • The second place to look is the Jira Administration Routines.

  • All the other routines are specifically meant for any Power Scripts feature you may be using. For example, if you are using Live Fields, look for Live Fields routines.

  • The last category of routines has to deal with things like math, string manipulation or array routines.

• If the routine you are looking for does not exist, consider implementing a script which consumes an Atlassian REST API (Jira Server/DC), (Cloud).

  • When developing SIL scripts which consume REST API, try using getting results with httpGet().

• Sometimes in your research Groovy fits the bill (available via the SIL Groovy Connector, Jira Server/DC only). Reasons for using Groovy are the following:

  • Groovy tends to run faster than REST API.

  • Only a “Groovy” solution exists and is the only way to create a workaround.

Things to Think About While Engaging in the Development Process

• I can, but should I?

  • If used incorrectly, certain implementations can result in code that takes to long or takes down your Jira instance.

• Migration minded.

  • Always keep in mind when developing code what it would take to migrate to the next version of Jira or Confluence when they come out.

• Does it scale?

  • Can the process being developed be used on a grand scale?

• Don't bake in bad processes.

  • Bad processes tend to multiply over time. If you do the first thing right, the process will get better over time.

• Leave the smallest footprint.

  • Write code that is direct, to the point and reads well.

  • Avoid code that uses a large amount of system resources.

• Use native Jira features whenever possible.

  • There is no need to reinvent the wheel. Jira is an amazing system, so use those features to accomplish your goals.

• Use Jira in the way it was designed to operate.

  • With scripting, the features you can implement are infinite. However, keep the functionality of your code to be in alignment with Atlassian best practices.

Related articles