This commit is contained in:
@@ -100,13 +100,11 @@ Use Docker with Docker Compose for local development and production deployment,
|
||||
### Reasoning
|
||||
- Docker ensures the application runs identically regardless of the host machine, reducing "works on my machine" issues during handoff.
|
||||
- Docker is an easier way of getting the full stack operational on a new contributors machine compared to making them do multiple different installs.
|
||||
- Docker Compose is simple enough for a non-specialist maintainer to understand and operate.
|
||||
- Separate override files (`compose.dev.yaml`, `compose.prod.yaml`, `compose.test.yaml`) allow environment-specific configuration without duplicating the base service definitions.
|
||||
- A VPS with Docker is significantly cheaper than a managed hosting service while providing more control.
|
||||
|
||||
### Consequences
|
||||
- New maintainers need minimal Docker literacy, but this is a reasonable baseline expectation.
|
||||
- The Makefile wraps common Docker Compose commands to reduce the surface area a maintainer needs to know day-to-day.
|
||||
- The Makefile wraps common Docker Compose commands to reduce increase ease-of-use.
|
||||
- Data persistence is handled via named Docker volumes.
|
||||
|
||||
---
|
||||
@@ -149,6 +147,7 @@ Use PEP8 as the style guide with enforced type hinting. Enforced using 'ruff' an
|
||||
### Consequences
|
||||
Linting checks have to integrated into the CI/CD pipeline.
|
||||
'Contributing.md' needs to be created to make it clear how to contribute.
|
||||
Linting tools will have to installed.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user