https://github.com/straw-hat-team/adr
Architecture Decision Record (ADR)
https://github.com/straw-hat-team/adr
adr architecture-decision-record databases elixir-lang genesis-adr golang nodejs programming-language reactjs straw-hat straw-hat-platform typescript
Last synced: 6 months ago
JSON representation
Architecture Decision Record (ADR)
- Host: GitHub
- URL: https://github.com/straw-hat-team/adr
- Owner: straw-hat-team
- License: mit
- Created: 2020-11-05T06:34:18.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T19:30:41.000Z (about 1 year ago)
- Last Synced: 2024-11-18T20:34:42.892Z (about 1 year ago)
- Topics: adr, architecture-decision-record, databases, elixir-lang, genesis-adr, golang, nodejs, programming-language, reactjs, straw-hat, straw-hat-platform, typescript
- Language: TypeScript
- Homepage: https://straw-hat-team.github.io/adr/
- Size: 109 MB
- Stars: 46
- Watchers: 10
- Forks: 5
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Architecture Decision Record (ADR)
TL;DR: ADRs are lots of documentation on how Straw Hat Team works.
## Overview
ADR stands for Architecture decision record, a design document providing
high-level, concise documentation for software development. The goal is for
these documents to serve as the source of truth for software-related
documentation at Straw Hat Team and the way teams discuss and come to consensus
on software development guidance.
## Getting started
### New to ADR?
If you're new to ADRs, check out the [Frequently Asked Questions](./FAQ.md)
which answer some common questions about how ADRs work and what you need to
know.
### Genesis ADR
[ADR#0000000000](./adrs/0000000000/README.md) is the genesis ADR.
### Have an idea for an ADR?
If you have an idea for an ADR that isn't written yet (yes, there are plenty!)
check out [Contributing to the project](./CONTRIBUTING.md) to see how you can
write ADRs for others to follow.
## License
Except as otherwise noted, the content of this repository is licensed under the
[Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/),
and code samples are licensed under the [MIT License](./LICENSE).