-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master' into sharelatex
* upstream/master: (26 commits) Fix test for quoted lang messages (#3424) Update gradle from 4.3 to 4.3.1 Fix #3411: ordering of fields in customized entry types works again (#3422) Backport of syncLang to python2 (#3420) Remove Versioneye badge Fix some error prone warnings Fix for issue #2721 append to a field (#3395) Fix travis - hopefully Remove 3.x changelog (#3250) Try to use hint of https://github.com/TheBoegl/shadow-log4j-transformer#usage-as-library Try to enable LGTM Update guava from 23.2 -> 23.3 (#3409) Update wiremock from 2.8.0 -> 2.10.1 Move groups field from others to general (#3407) Fix checkstyle issues to repair build Fix #3046: No longer allow duplicate fields in customized entry types (#3405) Strip invalid prolog when loading CitationStyles (#3404) Integrity check "Abbreviation Detection" detects abbreviated names for journals and booktitles based on the internal list instead of only looking for "." signs. (#3362) Update gradle from 4.2.1 to 4.3 Update gradle from 4.2.1 to 4.3 ...
- Loading branch information
Showing
89 changed files
with
670 additions
and
1,271 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
23 changes: 23 additions & 0 deletions
23
docs/adr/0000-use-markdown-architectural-decision-records.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Use Markdown Architectural Decision Records | ||
|
||
Should we record the architectural decisions made in this project? | ||
And if we do, wow to structure these recordings? | ||
|
||
## Considered Alternatives | ||
|
||
* [MADR](https://adr.github.io/madr/) - Markdown Architectural Decision Records | ||
* [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) - The first incarnation of the term "ADR". Maintainable by [adr-tools](https://github.com/npryce/adr-tools). | ||
* [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) - The Y-Statements | ||
* [DecisionRecord](https://github.com/schubmat/DecisionCapture) - Agile records by [@schubmat](https://github.com/schubmat/) | ||
* Other templates listed at <https://github.com/joelparkerhenderson/architecture_decision_record> | ||
* No records | ||
|
||
## Decision Outcome | ||
|
||
* Chosen Alternative: MADR | ||
* Implicit assumptions should be made explicit. | ||
Design documentation is important to enable people understanding the decisions later on. | ||
See also [A rational design process: How and why to fake it](https://doi.org/10.1109/TSE.1986.6312940). | ||
* The MADR template is lean and fits our development style. | ||
|
||
<!-- Pros and cons of alternatives straight-forward to elicit and therefore not captured. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,13 @@ | ||
# Architectural Decision Records | ||
# Architectural Decision Log | ||
|
||
This lists the architectural decisions for JabRef. | ||
This log 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 | ||
<!-- adrlog --> | ||
|
||
More information on architectural decision records is available at <https://adr.github.io/>. | ||
- [ADR-0000](0000-use-markdown-architectural-decision-records.md) - Use Markdown Architectural Decision Records | ||
|
||
<!-- adrlogstop --> | ||
|
||
For new ADRs, please use [template.md](template.md) as basis. | ||
More information on MADR is available at <https://adr.github.io/madr/>. | ||
General information about architectural decision records is available at <https://adr.github.io/>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,42 @@ | ||
# <Short Title of the Issue> | ||
# *[short title of solved problem and solution]* | ||
|
||
**UserStory:** <TICKET/ISSUE-NUMBER> | ||
**User Story:** *[ticket/issue-number]* <!-- optional --> | ||
|
||
<WRITE ONE SENTENCE DESCRIBING THE PROBLEM. (Optional)> | ||
*[context and problem statement]* | ||
*[decision drivers | forces]* <!-- optional --> | ||
|
||
## Considered Alternatives | ||
|
||
* <ALTERNATIVE 1> | ||
* <ALTERNATIVE 2> | ||
* <ALTERNATIVE 3> | ||
* *[alternative 1]* | ||
* *[alternative 2]* | ||
* *[alternative 3]* | ||
* *[...]* <!-- numbers of alternatives can vary --> | ||
|
||
## Conclusion | ||
## Decision Outcome | ||
|
||
* *Chosen Alternative: <ALTERNATIVE 1>* | ||
* <FURTHER RATIONALE (Optional)> | ||
* Chosen Alternative: *[alternative 1]* | ||
* *[justification. e.g., only alternative, which meets k.o. criterion decision driver | which resolves force force | ... | comes out best (see below)]* | ||
* *[consequences. e.g., negative impact on quality attribute, follow-up decisions required, ...]* <!-- optional --> | ||
|
||
## Comparison (Optional) | ||
## Pros and Cons of the Alternatives <!-- optional --> | ||
|
||
### <ALTERNATIVE 1> | ||
### *[alternative 1]* | ||
|
||
* + <ARGUMENT 1 PRO> | ||
* + <ARGUMENT 2 PRO> | ||
* - <ARGUMENT 1 CONTRA> | ||
* `+` *[argument 1 pro]* | ||
* `+` *[argument 2 pro]* | ||
* `-` *[argument 1 con]* | ||
* *[...]* <!-- numbers of pros and cons can vary --> | ||
|
||
### <ALTERNATIVE 2> | ||
### *[alternative 2]* | ||
|
||
* + <ARGUMENT 1 PRO> | ||
* + <ARGUMENT 2 PRO> | ||
* - <ARGUMENT 1 CONTRA> | ||
* `+` *[argument 1 pro]* | ||
* `+` *[argument 2 pro]* | ||
* `-` *[argument 1 con]* | ||
* *[...]* <!-- numbers of pros and cons can vary --> | ||
|
||
### <ALTERNATIVE 3> | ||
### *[alternative 3]* | ||
|
||
* + <ARGUMENT 1 PRO> | ||
* + <ARGUMENT 2 PRO> | ||
* - <ARGUMENT 1 CONTRA> | ||
* `+` *[argument 1 pro]* | ||
* `+` *[argument 2 pro]* | ||
* `-` *[argument 1 con]* | ||
* *[...]* <!-- numbers of pros and cons can vary --> |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.