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 and templates #15

Merged
merged 11 commits into from
Jan 16, 2024
Merged

Add ADR folder structure and templates #15

merged 11 commits into from
Jan 16, 2024

Conversation

samdbmg
Copy link
Member

@samdbmg samdbmg commented Jan 12, 2024

Details

Extends and supersedes #14 by adding documentation on how to run the ADR process. Also amends the PR template to make more sense in this repo.

Pivotal Story

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

Related PRs

Supersedes #14

Links to external test runs/working deployment

N/A

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 requested a review from a team January 12, 2024 14:16
@samdbmg samdbmg force-pushed the sammg-add-adr-process branch from 424f849 to bf31c13 Compare January 12, 2024 14:18
Adds a description of how to create ADR documents, and how they should
be managed and merged.
Removes some of the steps that either don't make sense for this repo, or
only make sense internally.
@samdbmg samdbmg force-pushed the sammg-add-adr-process branch from bf31c13 to 5a5622a Compare January 12, 2024 14:24
@samdbmg samdbmg mentioned this pull request Jan 12, 2024
18 tasks
@AndrewGibb AndrewGibb self-assigned this Jan 15, 2024
Copy link
Contributor

@AndrewGibb AndrewGibb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few things to resolve

docs/adr/decisions/README.md Outdated Show resolved Hide resolved
docs/adr/decisions/README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/adr/template/adr-template.md Show resolved Hide resolved
docs/adr/template/adr-template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
samdbmg and others added 3 commits January 15, 2024 13:36
Replaces the "force" and "facing concern" terms with the clearer
"requirement"
Adds some wording about facilitating the review process.
@samdbmg samdbmg requested a review from AndrewGibb January 15, 2024 15:17
Copy link
Contributor

@AndrewGibb AndrewGibb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@samdbmg samdbmg merged commit f0a3e3b into main Jan 16, 2024
3 checks passed
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.

4 participants