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

Restructure development documation #9058

Merged
merged 5 commits into from
Aug 15, 2022
Merged

Restructure development documation #9058

merged 5 commits into from
Aug 15, 2022

Conversation

koppor
Copy link
Member

@koppor koppor commented Aug 14, 2022

While working on a PR, I found the documentation inaccessible, because it is very distributed.

The restructuring idea is to have everything required in "daily" work inside "Code Howtos". Everything related to the "first day" inside "Getgting into the code".

Before

grafik

After

grafik

  • Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@koppor koppor merged commit 117a6f0 into main Aug 15, 2022
@koppor koppor deleted the refine-dev-docs branch August 15, 2022 21:16
Siedlerchr added a commit that referenced this pull request Aug 21, 2022
* upstream/main:
  Restructure development documation (#9058)
  Refine BackupManager (#9054)
  No need for "synchronized" at autosave, because there is a throttler (#9060)
  Reenable CiteSeerTest (#9062)
  Bump mockito-core from 4.6.1 to 4.7.0 (#9061)
  Squashed 'buildres/csl/csl-styles/' changes from c750b6e..b9302fd (#9059)
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.

1 participant