README.md

Development documentation

Getting started

• Development environment setup
• Running the server
• Loading database development seed data
• Development seed data organization members
• Resetting the database
• Running tests

Design concepts

General:

• [Technology stack]
• [System architecture]
• Directory structure
• Access control & roles

Data model domains:

• Organizations, users & service accounts
• Applications, releases & release events
• Approval rulesets, ruleset bindings, rules & rule outcomes
• [Creation audit records]

Data model core rules:

• Data model naming & casing conventions
• Implicit multitenancy fields & relations
• Non-nullable by default
• Default foreign key constraints

Data model core concepts:

• Multitenancy strategy
• Multitenancy & security: foreign key constraints
• Inheritance & polymorphism
• Undeletable resources
• Disableable resources
• The Immutability concept
• The Reviewable concept: versioning, auditing & reviewing changes

Database:

• Database migrations
• Enum types

REST API:

• Reviewable resources REST API pattern

Processes & tasks

Coding:

• [Changing the data model or the database schema]
• [Adding a new Reviewable resource]

Collaboration:

• Code review checklist
• Editing diagrams

Governance:

• Release process

Team handbook

Only applicable to core team members.

• [Way of working]