Skip to content

Project Conventions

Maria Martinez edited this page Jan 17, 2023 · 6 revisions

Confluence Page

Naming conventions

  • folders: everything in lowercase
  • files: keep suffix, for example: "TestClientService.java"
  • making name meaningful
  • avoid using acronym

Repos

  • Commit: follow git conventional commits
    for example:
    fix(fe:JIRA-1234)
    - commit message
    - refs: #[github_issue]
    
  • Github issues:
    • in the format of: [jira number]: [task name]
    • and put jira link inside the issue description
  • Pull request: in the format of: Merge #[github_issue]: [task name]
  • Branch: for example:
    fix/fe/[jira number]-[task], or fix/fe/[task]
    
  • Review process:

Contribution guideline

Version management

CLIENT application (The Ministry of Forests' client management system)

  • Architecture

  • Data Model

Clone this wiki locally