Chapter 5 Workflow

The following is the recommended workflow for coding projects in DASD. It has been included here to aid understanding of how the coding principles fit into the project life-cycle. For more detail on how to complete the Git steps, please read the section on Github flow.

1. Create/clone Github repo
   

• By storing your code in a repo you’re making it easier for others to collaborate on your project and to use pieces of your code elsewhere, as well as ensuring that your project will be accessible in the future.

2. Create issue
   

• Using issues to communicate what you’re working on helps to coordinate tasks between team members, creates a record of completed work and is useful for quality assurance purposes.

3. Create branch
   

• Creating a branch means that several people can work on a project simultaneously and protects the main codebase from any unwanted changes.
  

4. Set up dependency management
   

• Managing your project dependencies means that your project is more likely to be re-runnable in the future and on others’ machines.
  

5. Build in unit testing
   

• Unit tests provide confidence that your code is correct and can be used to pinpoint issues where they occur, making fixes quicker and easier.
  

6. Commit changes
   

• Committing your changes means that you can recover your work if you make a mistake and provides a record of changes for your reviewer.
  

7. Pull request and code review
   

• Ensuring that your code is reviewed provides both confidence in the accuracy of your code and the opportunity to share knowledge with colleagues.