Skip to content

introducing design decisions using adr-tools #109

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.

Sign up for GitHub

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

Jump to bottom
Open
iWebi wants to merge 2 commits into
base: master
Choose a base branch
from
Open

introducing design decisions using adr-tools #109

iWebi wants to merge 2 commits into from

Conversation

@iWebi
Copy link
Collaborator

@iWebi iWebi commented Apr 5, 2022

Resolves

Design decision documentation toolset

What

-Introduces Ceres CI/CD related design decisions discussed during engineering sync meetings

  • adr-tools (https://github.com/npryce/adr-tools) is chosen to document design decisions 
     git clone [email protected]:npryce/adr-tools.git
 export PATH=$PWD/adr-tools/src:$PATH
 cd to ceres project
 Add new document using adr-new "human readable decision title". Example below

 adr-new "Ensure Unit tests for Configuration Files"

Why

We need a record of design related decisions with related context for future documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rohitsngh27 rohitsngh27 Awaiting requested review from rohitsngh27

@shabd67 shabd67 Awaiting requested review from shabd67

@matsboman matsboman Awaiting requested review from matsboman

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@iWebi