Codify Architectural Decision Records and Changelog

Use Case

Consumers should know where the project has come and gone and contributors should clearly document changes.

Scope of Work

Formalize the process by which changelogs and decision logs are generated, and document this process.

Contextual Information

• Orchestrator has decision logs as a first iteration toward Architectural Decision Records.
• Orchestrator has a milestone file which is incomplete
• Orchestrator should have a changelog as part of the release process we are designing.

Acceptance Criteria

• Document how the decision records will be stored and organized
• Document the changelog process and requirements

Outputs

1. merge request to fit the existing decision records into the new format
2. merge request to document our decision record process
3. issue to review the milestones and create a basic changelog
4. merge request to document how Orchestrator changelogs will work