Skip to content

Upload Service Documentation

How it works

The upload service is a microservice that handles the uploading of files for all other services. The service is built using AdonisJS.

Git Conventions

We use the conventional commits specification for our Git commits. Please make sure to follow these guidelines when making commits.

  • Use present tense, imperative mood (e.g. "add feature" instead of "Added feature").
  • Keep commit messages short and descriptive.
  • Separate the subject from the body with a blank line.
  • Use bullet points to list the changes made in the commit.

Commit Types

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, npm)
  • ci: Changes to CI configuration files and scripts (example scopes: Travis, Circle)
  • chore: Changes which doesn't change source code or tests e.g. changes to the build process, auxiliary tools, libraries
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • revert: Revert something
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests