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

Initial idea for architectural decision records #3033

merged 1 commit into from
Jul 21, 2017

Conversation

koppor
Copy link
Member

@koppor koppor commented Jul 20, 2017

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/.

@Siedlerchr
Copy link
Member

@koppor
Copy link
Member Author

koppor commented Jul 20, 2017

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.

@koppor koppor merged commit 46f58d6 into master Jul 21, 2017
@koppor koppor deleted the add-adr branch July 21, 2017 13:09
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants