WorkFlow

Overall

Our development workflow in this project will follow the agile development methodology, as depicted below:

Flow Chart

flowchart TD
    A[Start] --> B[Issue Created]
    B --> |Auto| C[Branch Created]
    C --> D{Finished Develop?}
    D --> |Yes| E[Create Pull Request]
    E --> F{Passed Code Review?}
    F --> |Yes| G[Merge to Main]
    G --> H[Issue Closed]
    H --> J[End]
    F --> |No| I[Resolve Review Comments]
    I --> F

Loading

Description

1. All tasks, including features and bugs, begin by creating a GitHub issue.

2. When a new feature is created, a branch is automatically generated, and all coding should be performed in this specific branch.

   Remember: Never develop on the main branch.

3. Once you've completed your work on the issue branch, commit with meaningful comments and push to the GitHub repository. Verify on the remote repo that your code has been successfully pushed.

4. After successful push, GitHub will prompt you to create a new pull request to merge your code into the main branch. Follow through with this action.

5. Pull requests in this project require code reviews before merging. Select the reviewer (e.g., Tong) from the dropdown menu, and await their review.

6. Code review process:

• If your code is flawless, no changes will be required, and the reviewer will merge your code into the main branch.
• If your code requires modifications, address the review comments, then click the "Resolve comments" button. Once all changes are completed, push your code to the remote GitHub repo again, and request another review until no further changes are necessary.

7. And finally, the issue will be closed.