Data Brokerage Request Process

Process Overview of Managing Work Items

1. Intake Processing

• The process begins with the intake of project details using REDcap to gather all necessary requirements, defining the scope and objectives of the project.

2. Epic Creation

• In DevOps, a "Billable Epic" (a custom work item type created within the wustl-i2 Azure DevOps workflow) is created to serve as the primary organizational unit for the project, containing all related tasks and activities.

3. Work Item Management

• Work items representing individual Tasks are created within the Billable Epic. For data brokerage, these Tasks are typically parented to a User Story. A Billable Epic can have multiple User Stories.

4. Task Assignment

• Tasks are assigned to team members and sprints during sprint planning. The parent User Story also may be assigned to a specific user/team member.

Code Management in the Git Repository

Preparation

Compile all necessary details from the work items in the epic before creating folders in the Git repository. This ensures the repository structure aligns accurately with the team standards and includes details from the epic. Create a new branch for the work related to this request. The branch name should follow this naming convention: project/<epic-id>. This makes it easy to find the correct branch, and ensure branch name duplication does not occur.

For New Project Requests

• Folder Creation:
  • Establish a new folder using the naming convention <epic id>-<pi name>-<project name>.
• Initialization:
  • Create an index.md file within this folder to provide an overview of the project and document pertinent details from the work items and relevant code information.
• Adding Content:
  • Populate the folder with scripts, notebooks, and additional necessary project files.

For Ongoing Projects / Follow-up Requests

• Identifying Existing Folders:
  • Locate the existing project folder in the repository.
• Subfolder Creation (Optional):
  • Create a new subfolder named after the new Epic ID if the project folder is extensive or expects many new files.
• Content Updates:
  • Add new scripts, notebooks, and documents to the project folder or the new subfolder to keep the project's codebase up-to-date.

Finalization

After organizing the folder structure and integrating all necessary files, review the changes. Commit the changes to the repository, and submit a pull request for review and merging by the appropriate team member.

Conclusion

This approach ensures the Git repository is organized, and easy to navigate. It emphasizes structured updates, and careful review, to ensure quality and collaboration. This strategy ensures team members can access and contribute to the codebase effectively.