yogstation13 / yogstation-api Goto Github PK

Every time a new commit is made a automated testing suite should be started to ensure that no tests fail after a code change.

Preferably this should be done using an existing CI / CD platform such as Github Actions, Jenkins or Travis CI.

Currently testing only consists of integration tests for endpoints. Although integration tests are great, they are not perfect and cant test every aspect of the logic.

Ideally each class containing logic should have unit tests written for it. The only exception are bean classes that only contain getters and setters.

Users with the permission loas.list should be able to see all LOA's that have not been deleted. Users with the permission loas.deleted should be able to see deleted LOA's

Dependent on #1

A standards document must be created to help developers write code and to help reduce the time taken for a PR to be reviewed.

This document should outline

• Testing practices
• Sample data practices
• Documentation practices

It should also outline some basic coding standards such as tabs, bracket positioning and variable naming.