Initial idea for architectural decision records #3033
Merged
Conversation
This file contains hidden or 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
Member
Member
Author
|
This is also related: https://github.com/JabRef/jabref/blob/master/CONTRIBUTING.md#when-making-an-architectural-decision -- no one every did it until now. I would move everything from the wiki to docs/ and enable gh-pages build from master-branch/docs and render it at https://jabref.github.io/jabref. I think, 90% of the information can be moved, but pages like https://github.com/JabRef/jabref/wiki/Templates and https://github.com/JabRef/jabref/wiki/Acquiring-Contributors should be moved somewhere else. |
Siedlerchr
added a commit
that referenced
this pull request
Jul 31, 2017
* upstream/master: (41 commits) update xmlunit from 2.3.0 -> 2.4.0 update wiremock from 2.6.0 -> 2.7.0 update controlsfx from 8.40.12 -> 8.40.13 Fix group freeze by running markBasechange in swing thread (#3058) Localization: French: translation of new entries (#3050) Fix ads fetcher (#3048) Update translation (#3041) Translate new strings (#3040) Fix navigation in entry editor increases modifies font size (#3037) Initial idea for architectural decision records (#3033) Readd comment Readd comment Fix keybdining in entry editor in localized installation (#3030) Structuring Upgrade shadowJar Modernizer improvements Replace Reimplement MappedList.kt (#3032) Use https for the maven ej-technologies repo Upgrade modernizer plugin Remove separator next to search bar ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'd like to improve the code documentation of JabRef to make is easier for newcomers to understand the code. One part of that is to document the ideas behind of some code. This PR adds an initial directory and template for that.
I tried to collect background information at http://adr.github.io/.