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

[Quality] Check ADR completeness #47

Open

koppor opened this issue Aug 28, 2020 · 1 comment

Labels

Collaborator

koppor commented Aug 28, 2020

(TBD at the last sprint)

Check "Quality" of the added Check alls ADRs

Are there ADRs missing?
Is each ADR consistent in itself?
Are all ADRs consistent among each other? (It is OK if there are short ADRs and longer ADRs. Nevertheless, the "writing style" should be the same.

It is OK to to it at the end: A Rational Design Process: How and Why to Fake it.

koppor changed the title ~~[Quality] Check ADR compelteness~~ [Quality] Check ADR completeness

Collaborator Author

koppor commented Oct 2, 2020

Example for JabRef: https://github.com/SE761Team4/jabref/blob/jabmap/docs/adr/template.md
Reading on ADRs: https://adr.github.io/madr/

lolagarden added the documentation label

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