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

Use the ADR (Architectural Design Record) pattern for documenting significant decisions #573

Merged
merged 2 commits into from
May 4, 2022

Conversation

dbeatty10
Copy link
Contributor

This is a:

  • documentation update
  • bug fix with no breaking changes
  • new functionality
  • a breaking change

All pull requests from community contributors should target the main branch (default).

Description & motivation

Quoting Michael Nygard:

One of the hardest things to track during the life of a project is the motivation behind certain decisions. A new person coming on to a project may be perplexed, baffled, delighted, or infuriated by some past decision.

Therefore:

We will keep a collection of records for "architecturally significant" decisions: those that affect the structure, non-functional characteristics, dependencies, interfaces, or construction techniques.

This PR seeds Nygard's original problem/solution strange loop into our project using the minimal amount of Markdown.

@dbeatty10 dbeatty10 requested a review from jasnonaz May 3, 2022 16:14
Copy link
Contributor

@jasnonaz jasnonaz left a comment

Choose a reason for hiding this comment

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

This is fantastic, thank you for getting this set up @dbeatty10! ⭐

@dbeatty10 dbeatty10 merged commit 9d93773 into main May 4, 2022
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