tool_rad
Record Architecture Designs - a tool to facilitate ADR creation and management
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.4%) to scientific vocabulary
Keywords
Repository
Record Architecture Designs - a tool to facilitate ADR creation and management
Basic Info
Statistics
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
rad - Record Architecture Decisions
A small tool to help you record your architecture decisions
Table of Contents
About
This project is a continuation of the talo
project in the sense to provide a single tool to manage Architecture Decision
Reports (ADRs) within projects. Unlike talo, rad is meant to soley focus on
ADRs and limit user configuration in the spirit of
black. Additionally, this tool takes
inspiration from git to allow you to record ADRs
anywhere within the project instead of just in the project's root directory.
How To Install
The following instructions allow you to build rad locally:
shell
git clone https://github.com/NicholasSynovic/tool_rad
cd tool_rad
cmake .
make
cp ./bin/rad ~/.local/bin/rad
How To Configure rad
You can initialize rad with:
shell
rad init
This will create a .rad.json file in the current directory.
The .rad.json file is intentionally sparse. The following options can be
configured in the file:
adr_directory: The relative path to store ADRs.- Default:
docs/adr
- Default:
adr_format: The format of the ADRs.- Default:
nygard. - See ADR Formats for a list of availible formats
- Default:
ADR Formats
The following ADR formats are supported:
edgex: EdgeXbusiness: Businessmadr: Markdown ADR (MADR)tyree: Tyreeplanguage: Planguagealexandrian: Alexandriannygard: Nygard
Owner
- Name: Nicholas Synovic
- Login: NicholasSynovic
- Kind: user
- Location: Chicago, IL
- Website: https://nicholassynovic.github.io/
- Repositories: 89
- Profile: https://github.com/NicholasSynovic
Loyola University Chicago Computer Science Student Expected Graduation: May 2022
Citation (CITATION.cff)
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
GitHub Events
Total
- Watch event: 1
- Push event: 32
- Create event: 1
Last Year
- Watch event: 1
- Push event: 32
- Create event: 1
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3 composite
- actions/setup-python v3 composite
- pre-commit/action v3.0.1 composite