Questions from contractors

1. What is the role of teams, committees and project deliverables in the system

A team is an entity that can participate (enroll) to different competitions. For every enrollment, a team develops a project.

Each competition specifies a list of deliverables (Project Deliverables), which must be submitted by every enrolled team.

Every competition has a number of committees (group of people). Committees, system-wise, will be mainly used for controlling access and permissions (not yet implemented). Similar to a team, the implementation of committees makes them "enroll" to different competitions.

2. Deployment environments

Currently, we have two environmnets: production (https://api.igem.io), always up to date to production branch; and development (https://api-dev.igem.io), used for deploying on-going work from other branches. We can envisage a new environment for staging.

3. Branch name convention and pipelines

The production branch is protected againts pushes, and only Maintainers can accept Merge Requests into it. Every commit to production triggers, building, testing and deployment to the production environment.

On-going work must be done in a dedicated branch, one feature/module at a time. Every push to any other branch will trigger a build and testing pipeline jobs. The pipeline job to deploy to the development environment must be triggered manually.

4. Merge requests

Once a feature/module is ready to be deployed to production (i.e., it has been fully implemented, tested, documented and migrations were created), a Merge Request should be created. A Maintainer should be assigned as reviewer.

5. User roles and ACL

Still to be designed. Probably, there should be at least three system-level roles: user, hq, and admin. These are an attribute for each user. At the bussiness-level, permissions will be granted to users according to their enrollment to a team, committees, etc.

6. Which Unit test to do Mocha Chai / Jest

Chai is implemented

7. Job queue (Bull)

We use Bull for managing jobs. Jobs are used to asynchronous processing and repeatable tasks.