Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ADR folder structure, templates and initial ADR doc #14

Merged
merged 3 commits into from
Jan 16, 2024

Conversation

robwadge
Copy link
Contributor

@robwadge robwadge commented Jan 9, 2024

Details

Add folder structure to support use of Architectural (Any) Decision Records
Add MADR template and apply slight modifications to simplify for our use
Create an initial ADR doc from the template to document the decision to use (M)ADRs

Pivotal Story

Story URL: https://www.pivotaltracker.com/story/show/186644493

Related PRs

Where appropriate. Indicate order to be merged.

Links to external test runs/working deployment

Where appropriate, if separate to default CI run

Submitter PR Checks

(tick as appropriate)

  • Added bbc/rd-apmm-cloudfit team as a reviewer
  • PR completes task/fixes bug
  • Tests exercise code appropriately
  • New features and API breaks are flagged in commit messages using magic strings
  • Repo maintainer is notified that a release is required
  • Documentation updated (README, Confluence, Docstrings, API spec, Engineering Guide, etc.)
  • Downstream repos have been checked for potential breaks & fixed as needed
  • APIs/UIs/CLIs updated as required
  • PR added to Pivotal story
  • Follow-up stories added to Pivotal
  • Any temporary code/configuration removed (e.g. test deployment environment, temporary commontooling branch)
  • Any pins against pre-releases have been removed

Reviewer PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • Tests exercise code appropriately
  • Design makes sense, and fits with our current code base
  • Code is easy to follow
  • PR size is sensible
  • Commit history is sensible and tidy

Info on Cloudfit PRs

@samdbmg samdbmg mentioned this pull request Jan 12, 2024
18 tasks
@samdbmg samdbmg merged commit c367de6 into main Jan 16, 2024
3 checks passed
@samdbmg samdbmg deleted the rw-add-adr-process branch April 2, 2024 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants