This log lists the architectural decisions for hamlet. This log aims to document core architectural concepts and conventions that we use within hamlet. The log is intended to cover conceptual ideas and conventions and should not include implementation or operational documentation.
The records below are accepted Design records which we follow as part of hamlet
- ADR-0000 - Use Markdown Architectural Decision Records
- ADR-0001 - Executor Engine Separation
- ADR-0002 - Layer Level Deployments
- ADR-0003 - Include Implementation Log as part of Decision Records
- ADR-0004 - [Provide Users an Error Code on Fatal Error]
- ADR-0005 - [Convention-based Logging Classes]
- ADR-0006 - Hamlet Engine distribution through docker image layers
- ADR-0007 - Placement Support
For new ADRs, please use template.md as basis. More information on MADR is available at https://adr.github.io/madr/. General information about architectural decision records is available at https://adr.github.io/.
- Copy the template.md file into the
adr/directory - Rename the file to NNNN-title-with-dashes.md, where NNNN indicates the next number in sequence and title is the tile of the ADR based on the description in the template
- Update the template content to outline the decision you want to define
- Update the Log
- Raise a PR with your ADR to this repo and add the engine-maintainers as reviewers
- Once approved, update the approval details at the start of the ADR then merge the PR
- Raise an issue using the Implementation Log issue template
- Link any PRs raised during implementation to this issue
- Refine the ADR where necessary with any details that arise during implementation
- Close the issue when the maintainers are satisfied that the ADR has been implemented based on its accepted record
To Update the log above run the following commands from the root of the repo
npm install
npx adr-log -i README.md -d adr/
This will update the ADR log entry above with any new ADRs which have been created