Name Conventions

Angular

We will use naming conventions as provided in the style guide of Angular.

Therefore, we will use PascalCase for components, and models. (e.g., UserProfileComponent, FireMap),
camelCase for services and variables, (e.g., mapService),
and kebab-case for files and folders names (e.g., user-profile.component.ts)

Springboot

We will use naming conventions as provided in the code conventions of Java.

Git Conventions

Commit message conventions:

General Structure: <GitHub-Task-ID>-<type>(<scope>):<description>

• <type>: Describes the purpose of a commit. Examples:

  • feat: A new feature
  • fix: Bug fix
  • style: Change that does not affect logic
  • docs: Documentation changes
  • refactor: Code changes that does not fix a bug or add a feature
  • test: Adding or updating tests
  • chore: Maintenance tasks (e.g., updating dependencies)

• <scope>: Indicates the part of the project affected, since we are in a monorepo architecture. (e.g., api, auth, ui).

• <subject>: A brief and clear description of the changes.

Example:

• feat(auth): add OAuth login support

Commits should be small and focused on specific change!!

---

Branch naming conventions

General Structure: <type>/<short-description>

• <type>: Describes the purpose of a commit. Examples:

  • feat/ for new feature
  • fix/: for bug fix
  • chore/: for maintenance
  • hotfix/: for urgent fixes
  • test/: for test changes

• <short-description>: A few keywords describing the branch's purpose, separated by dashes.

Example:

• fix/navbar-alignment

---

Pull request conventions

General Title Structure: <GitHub-Task-ID>-<type>(<scope>):<description>

Here is a template to maintain consistency throught Pull Requests:

### Summary
Provide a short description of what changes are introduced.

### Changes Made
- Change 1
- Change 2
- ...

### Testing Instructions
Steps to verify that the changes work as expected.

### Screenshots (if applicable)
Attach screenshots demonstrating the changes.

### Additional Notes
Anything else relevant for the reviewers to know.