Skip to content
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.

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

Initial idea for architectural decision records #3033

Merged
merged 1 commit into from
Jul 21, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/adr/0000-use-architectural-decision-records.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Use Architectural Decision Records

We need to record the architectural decisions made on this project.

## Considered Alternatives

* No record
* [DecisionRecord](https://github.com/schubmat/DecisionCapture)
* [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), maintainable by [adr-tools](https://github.com/npryce/adr-tools)
* [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions)
* [Other templates](https://github.com/joelparkerhenderson/architecture_decision_record)

## Conclusion

* *Chosen Alternative: Decision Record*
* That template is lean and fits most the development style
8 changes: 8 additions & 0 deletions docs/adr/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Architectural Decision Records

This lists the architectural decisions for JabRef.

- [0000-use-architectural-decision-records.md](0000-use-architectural-decision-records) - Use Architectural Decision Records
- [template.md](template/) - the template

More information on architectural decision records is available at <https://adr.github.io/>.
36 changes: 36 additions & 0 deletions docs/adr/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# <Short Title of the Issue>

**UserStory:** <TICKET/ISSUE-NUMBER>

<WRITE ONE SENTENCE DESCRIBING THE PROBLEM. (Optional)>

## Considered Alternatives

* <ALTERNATIVE 1>
* <ALTERNATIVE 2>
* <ALTERNATIVE 3>

## Conclusion

* *Chosen Alternative: <ALTERNATIVE 1>*
* <FURTHER RATIONALE (Optional)>

## Comparison (Optional)

### <ALTERNATIVE 1>

* + <ARGUMENT 1 PRO>
* + <ARGUMENT 2 PRO>
* - <ARGUMENT 1 CONTRA>

### <ALTERNATIVE 2>

* + <ARGUMENT 1 PRO>
* + <ARGUMENT 2 PRO>
* - <ARGUMENT 1 CONTRA>

### <ALTERNATIVE 3>

* + <ARGUMENT 1 PRO>
* + <ARGUMENT 2 PRO>
* - <ARGUMENT 1 CONTRA>