-
Notifications
You must be signed in to change notification settings - Fork 0
Conventions
Alessandro-AP edited this page Jan 28, 2022
·
17 revisions
This repository and its code are written in English only.
We use Java best naming convention practices.
Since all the members of the development team use intellij, we decided to use the default formatting of the IDE. This allows us not to have to worry too much about formatting our code while we are writing, but it does require us to do the CTRL+ALT+L shortcut before a push.
For documentation we use the Javadoc style at the head of classes and sometimes at methods (only when it is considered necessary).
| Topic | Description |
|---|---|
| Team | Documents related to team structure |
| Development Process | Documents related to software development process |
| Architecture | Documents related to software architecture |
| Conventions | List of naming and coding conventions |
| Technologies | List of all the technologies used in the project |
| Business Logic | Business logic documentation |
| Security | Security and Authentication |
| Authentication microservice | Authentication microservice documentation |
| Retrospectives | Lessons learned |