Restructuring developer documentation for easier reach #11507
Closed
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.
contributing.md
used to be an independent topic in the devdocs in itself.Apart from having its own original content as index, we propose to make it a parent that has two children:
1a."JabRef's development strategy",
1b."Setting up a local workspace" and
1c."High-level documentation"
This used to be an independent section in itself, which will be shifted here.
This makes important documentation more prominent to reach for newcomers.
This PR also fixes some grammatical errors in FAQs, and adds some pointers about reaching IntlliJ Settings in M2 Macs while setting up the development environment.
Update: Also adds the link to the developer FAQs in the github actions bot newcomer greeting message.
Mandatory checks
Change inCHANGELOG.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)