Guidelines for Jira management

Learn how to handle user stories and tasks in Jira

Analysis

Description Tool State
Create Analysis Task JIRA [X]
Create Analysis Documentation Confluence [X]
. . . Use cases [X]
. . . Data model [X]
. . . Component architecture [X]
Create “doubt repository” JIRA/Confluence [X]
Have all doubts been resolved? [X]
Has the result of the analysis been presented? [X]
Have several alternatives been evaluated? [X]
Has the chosen option been agreed upon? [X]
Chosen solution meets the performance requirements? [X]

Development

Description Tool State
Create branch “feat” for each task GIT [X]
Create unit tests GIT [X]
Create Documentation (README) GIT [X]
Add lint rules (standard) GIT [X]
Create jenkins tasks (if they don’t exist) JENKINS [X]
Check for missing jenkins tasks JENKINS [X]
Does the code pass all unit tests? [X]
Do the unit tests cover 80% coverage? [X]
Does the code comply with the lint rules? [X]
Have the Jenkinsfile and pipelines been checked? [X]
Is the README documentation up to date? [X]

FAQs

What to do if you have to integrate with another development team?

If, for example, we are going to integrate something with the Cognitive Team, such as the new suggestions API, we will be talking to them integrated in the same team all the time.

But the moment we need them to pass us their swagger, whether their component is deployed or the update deployed, we will give them a task to do so.

How to upload the code to git?

To upload the code to git, Pull Request to master or release/* is performed depending on the moment.

We upload it when we have finished, with a disclaimer: if we are dependent on other teams that are going to call our API or use the modification for something, we will be especially careful and upload the changes when they are necessary and not to break their development.

Do I have to notify QA at the end of coding?

Yes, you have to notify them when a new feature or a fix is deployed in the corresponding environment.

If it is bug or complete US, passing them to resolved they are already warned, but I like more to give them a touch and tell them.

In addition to when we upload the code, I like to share the analysis and design pages with them, because the discussions are usually very productive.

Should we notify someone about the generated documentation?

We must notify María Eugenia, who is the documentary maker. The ideal is to leave indicated in each US/Bug which documentation has been modified with its development. María Eugenia takes the doc from aura-docs, from Confluence or from the corresponding repo and includes it in the product versions.

How do the tasks change states?

We must pass the US/bugs from “new” -> “in progress” -> “code review” -> “resolved”. Tasks in the “resolved” state go “closed” when QA validates them.

How do I change version of component or library?

We do this process with each release or phase change. The future is that everything is done automatically by Jenkins.