Skip to content

Updated architecture and components link in CONTRIBUTING.md#13606

Merged
koppor merged 2 commits into
JabRef:mainfrom
amndaone:fix-for-issue-13586
Jul 29, 2025
Merged

Updated architecture and components link in CONTRIBUTING.md#13606
koppor merged 2 commits into
JabRef:mainfrom
amndaone:fix-for-issue-13586

Conversation

@amndaone

Copy link
Copy Markdown
Contributor

Closes #13586

In the pull request process for CONTRIBUTING.md, the steps previously linked to high-level documentation. Needed to be updated to architecture and components and its corresponding link.

Steps to test

To test this feature, check if the link to leads to the the architecture and components devdocs page when reviewing the 'Pull Request Process' section on CONTRIBUTING.md. Note: While I did see the mention for the .md link, I used .html since CONTRIBUTING.md is primarily viewed on Github. Users clicking on .md link would receive a 404 error. This link format matches other documentation links in the same file. If any changes are needed, or if there any issues due to this I am welcome to change it accordingly.

image

Users should see the above screenshot when clicking the corresponding link.

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [/] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
  • [/] Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (if change is visible to the user)
  • 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 commented Jul 29, 2025

Copy link
Copy Markdown
Member

Steps to test

Very long text 😅

To test this feature, check if the link to leads to the the architecture and components devdocs page when reviewing the 'Pull Request Process' section on CONTRIBUTING.md. Note: While I did see the mention for the .md link, I used .html since CONTRIBUTING.md is primarily viewed on Github. Users clicking on .md link would receive a 404 error. This link format matches other documentation links in the same file.

Dive into Jekyll / static-site generators to learn more about this.

.md is the source --> available in the source repo

.html is the generated thing --> rendered on GitHub pages

Bonus: "Pretty URLs" - read on at https://en.wikipedia.org/wiki/Clean_URL

I will remove the html and then merge.

@trag-bot

trag-bot Bot commented Jul 29, 2025

Copy link
Copy Markdown

@trag-bot didn't find any issues in the code! ✅✨

@koppor koppor merged commit 704918a into JabRef:main Jul 29, 2025
1 check passed
Siedlerchr added a commit that referenced this pull request Aug 2, 2025
* 'main' of github.com:JabRef/jabref: (26 commits)
  Change Open AI to Open AI  (or API Compatible)  (#13608)
  Remove all assignment tracking labels
  Updated architecture and components link in CONTRIBUTING.md (#13606)
  #13301 Fix/unicode reference marks (#13590)
  Show fetch exception at citation relation (#13549)
  More jbang caching
  Sequential run for moving issues
  Update CSL Styles (#13601)
  Fix gradle issues (#13603)
  Add System.exit (#13510)
  New Crowdin updates (#13600)
  Automatic lookup DOI at citation information. (#13596)
  Update heylogs from 0.10.0 to 0.11.1 (#13594)
  add fallback and reenable defaultcomeslast (#13593)
  Fix debian vagrant image (#13589)
  Fix: Replace string "Tests" with "Source Code Tests" in PR Comment (#13587)
  Fix version for SNAPSHOT (#13581)
  Update JDK and JavaFX (#13580)
  Add icon (#13579)
  Fixes link I broke in PR 13568 (#13577)
  ...
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.

Contribution Guide points to non-existent URL

2 participants