Introduce Architecture Decision Records #13
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
requested review from
|
A |
ch1bo
reviewed
Jun 9, 2021
docs/README.md
Outdated
| @@ -0,0 +1,3 @@ | |||
| # Documentation | |||
|
|
|||
| * Technical [Architecture](architecture.md): Main entry point for technical details about Hydra node implementation | |||
There was a problem hiding this comment.
This indirection is not required IMO, I'd just put the technical architecture document in place here until we have other docs.
docs/architecture.md
Outdated
| Please refer to each component's internal documentation for details. | ||
|
|
||
| * The [HydraNode](../hydra-node/src/Hydra/Node.hs) is a handle to all other components' handles | ||
| * This handle is used by the main loop to `processNextEvent` and `processEffect` |
There was a problem hiding this comment.
Anything referring to actual identifiers should be in the module haddock IMO. But this is out of scope for this PR and I gladly help in moving these things and make it coherent :)
| ## Decision | ||
|
|
||
| * We will use _Architecture Decision Records_, as described by Michael Nygard in this article: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions | ||
| * We will follow the convention of storing those ADRs as Markdown formatted documents stored under `docs/adr` directory, as exemplified in Nat Pryce's [adr-tools](https://raw.githubusercontent.com/npryce/adr-tools). This does not imply we will be using `adr-tools` itself. |
|
|
||
| ## Consequences | ||
|
|
||
| See Michael Nygard's article, linked above. |
There was a problem hiding this comment.
Wouldn't it be helpful to extract the bits we deem as important here? or do we expect anyone to read the article anyway?
ch1bo
approved these changes
Jun 9, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Architecture Decision Records, or ADRs, are a form of lightweight documentation of the architecture, or more generally technical, decisions made or revoked during the development of a system.