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

Pull Request Title:

General Title Structure:

• <GitHub-Task-ID>-<type>([optional scope]): <description>

Type list:

• <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

Example:

• #37 - feat(docker): Setting Up Docker

Commit message conventions:

General Structure:

• <GitHub-Task-ID> - Clear description of the changes.

Example:

• #1 - Added OAuth login support in Login.tsx

Commits should be small and focused on specific change!!

---

Branch naming conventions

General Structure:

• <GitHub-Task-ID> - <short-description>

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

Example:

• #12 - navbar-alignment

---

Pull request description

Here is a template to maintain consistency through 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.

Example

Please refer to the following PR.