Development Process - lulu98/projects-with-sel4 GitHub Wiki

Development Process Guidelines

Development workflow

The following workflow is recommended when working on a new CAmkES application:

  1. Create a new branch.
  2. Develop your application on the new branch.
  3. Debug it with the linter scripts in src/test/linter/
  4. Run the build.sh and test.sh scripts locally.
  5. Trigger a CICD run on GitHub on the new branch.
  6. If CICD turns green on GitHub, merge with main branch.

Git

In this project, commit flags are used in order for the developer to have a better understanding of what type a commit is. This project uses the following commit flags:

  • DEV: this flag refers to changes in the source code
  • DOC: this flag refers to changes in the documentation, e.g. Readme files
  • TEST: this flag refers to changes in test files
  • FIX: this flag refers to a functional fix
  • FORM: this flag refers to a fix that enhances the form, e.g. fixing spelling errors
  • CICD: this flag refers to changes in the CICD pipeline

A commit has the following form:

<hash> [<commit-flag>] <commit-message>
⚠️ **GitHub.com Fallback** ⚠️