Skip to content
This repository has been archived by the owner on Jan 17, 2024. It is now read-only.

Latest commit

 

History

History
84 lines (60 loc) · 5.83 KB

11-00-jira-workflow.md

File metadata and controls

84 lines (60 loc) · 5.83 KB

(aea-jira-workflow-a-guide)=

AEA Jira workflow - A guide

For pre-publication verification, we use a Jira-based workflow similar to the post-publication processes described in the Wiki. For AEA work, that post-publication process can be ignored.

The link to JIRA is [https://aeadataeditors.atlassian.net/jira](https://aeadataeditors.atlassian.net/jira) (requires login).

Scope

Your supervisor will assign you to this workflow. This workflow covers code and data, even when data may not be accessible. Supervisor, see other document for details.

Overview

jira image

The following table illustrates the flow and transitions. The transition field identifies the button that will appear in the interface that needs to be clicked in order to progress an issue from the From state to the To state. The Condition field identifies which form field needs to be filled out in order to be able to make the transition. Blocked is always an option, and leads to a "waiting state" until a resolution can be found.

From Transition → To Condition
Assigned Start task → In Progress
In Progress Download code → Code Replication package URL have been filled out, Journal has been identified, Empirical Article=Yes, External validation != "yes"
Code Access data → Data Git working location, Data provenance have been filled out.
Data Prepare preliminary report → Write Preliminary Report
Write Preliminary Report Some data is accessible → Verification DatasetsIncluded = Some or All, Working location of data, Computing environment have been filled out.
. Data not available → Code review Reason for non-accessibility of data has been filled out.
Verification, Code review Prepare report → Report
Report Submit for review → Report Under Review Report URL has been filled out.
Multiple Need information → Incomplete when information is missing
Incomplete Restart → Code review
. Restart verification → Verification
. Restart task → In Progress

The following are only relevant for "Approvers" or "Pre-Approvers" (if you have not been told you are a "(Pre-)Approver", you are not.)

From Transition → To Condition
Open Assign → Assigned
In Progress Alternate Workflow → Alternate Workflow
Under Review Approve → Approved Can only be done by approvers.
Pre-approved Approve → Approved Can only be done by approvers.
Under Review Pre-Approve → Pre-Approved Can only be done by pre-approvers.
. Incomplete → Incomplete n.a.
Approved Done → Done n.a.
Blocked Reopen → Open n.a.

The following are only relevant for "Publishers" (if you have not been told you are a "Publisher", you are not.)

From Transition → To Condition
Approved Submit to MC → Submitted to MC MCRecommendationV2 is filled out
Submitted to MC Wait for response on ICPSR → Pending openICPSR changes MCRecommendationV2 is Accepted with changes and notes to be added on openICPSR
Submitted to MC Prepare for publication → Pending Publication openICPSRVersion is filled out, issue is NOT an R&R
Pending openICPSR changes Prepare for publication --> Pending Publication openICPSRVersion is filled out, Changes have been satisfied on openICPSR
Pending Publication Publish → Published openICPSRDOI is set

Notes

  • In the Issue form, please also fill out other fields, as noted.
  • At any point, you can move the issue to Incomplete: more information/action is required before you can proceed. You should also notify us of the situation ASAP
  • When committing, you can use Smart Commits, e.g.

AEAREP-1234 #comment corrected indent issue

  • Use JIRA comments to communicate with your supervisor as issues arise, including code that takes a long time to run.

Details

Additional details for each of the key stages are provided here. Below is a screenshot of a Jira ticket. Some things to note:

  • The blue In Progress box in the upper right - area 3 of the screen - is how you "advance" the Jira ticket. When you are first assigned a replication, this box will say Open.
  • The tall grey bar on the left side - area 1 of the screen - contains several handy links that you will use throughout the process.
    • Sometimes this box is not visible. To make it visible, edit the URL for the Jira ticket so that there are no characters after the ticket number (e.g. AEAREP-123). You may have to refresh the page after doing so.

jira screen