Naming conventions and best practices

🔥🔥🔥

Error message

Format of error messages thrown from the API

{
  "status": 400,
  "message": "Bad Request",
  "errors": [
    { "firstname": "Firstname must contain at least 7 characters" }
  ]
}

Git branch

Format:
{story type}-{word summary}
Type of the story shows the context of the branch and should be one of:
feature bug chore

Example feature-account-registration

Pull Request

# PR Details

## What has been done in this PR?

## How should this be manually tested?

## Types of changes

- [ ] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

Commit message

Coming soon

Environment variables

The names of environment variables are case-sensitive; let's use UPPERCASE to name and keep variables in one format

example:
EDITOR=vi