From b5f3cec8ef40b63dfc6e19213771c1612dfc06db Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 09:30:07 +0200 Subject: [PATCH 01/18] Add howto for local clone --- en/contributing/README.md | 46 +++++++++++++++++++++++++++++++++------ 1 file changed, 39 insertions(+), 7 deletions(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 0b6e36118..9f8ff4d86 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -1,16 +1,48 @@ -# Contribute to JabRef +# Contribute to JabRef [![Join the chat at https://gitter.im/JabRef/jabref](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JabRef/jabref) We are really happy that you are interested in contributing to JabRef. Please take your time to look around here. We especially invite you to look into our [community members page](https://discourse.jabref.org/t/community-members/1868?u=koppor) where members introduce themselves. -**I would like to improve the help page. What are the steps?** [![Join the chat at https://gitter.im/JabRef/jabref](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JabRef/jabref) +**I would like to try out a feature introduced at pull request. What are the steps?** -Please use the "Edit on GitHub" link in the upper right corner. Then, follow [GitHub's guide to edit files in other user's repository](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files#editing-files-in-another-users-repository). +In JabRef, there are dozens of bug fixes and new features introduced using GitHub's pull request mechansim. +You can browse all at . +The JabRef team really welcomes users to try out these additions and to comment on them. +Getting in improvements at this stage is much easier than fixing afterwards. -**I would like to help to translate JabRef to another language. How do I get started?** [![Join the chat at https://gitter.im/JabRef/jabref](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JabRef/jabref) +If you and the command line are friends, then it is very easy to try out pull requests and give feedback. +In the following, we try to give a minimal set of installation instructions to be able to run a contribution from a fork. + +Prerequisites: + +- [`git`](https://git-scm.com/) - The version control system +- [GitHubCLI](https://cli.github.com/) - A command-line client to GitHub install it using the installer linked from their [homepage]((https://cli.github.com/)) or [the commands given at the installation hints](https://github.com/cli/cli#installation). +- A JabRef project checkout. On Windows, we recommend: + - `mkdir c:\git-repositories` + - `cd c:\git-repositories` + - `git clone --recurse-submodules https://github.com/JabRef/jabref.git JabRef` + - `cd JabRef` +- [`gg.cmd`](https://github.com/eirikb/gg) - A cross-platform and cross-architecture version manager. Download [`gg.cmd`](https://github.com/eirikb/gg/releases/latest/download/gg.cmd) and store it in the `JabRef` directory + +Try a branch: + +1. `cd` into the `JabRef` directory: `cd c:\git-repositories\JabRef` +2. Checkout out the pull request: `gh pr checkout 13111` - where `13111` is the PR number, in this case [pr#13111](https://github.com/JabRef/jabref/pull/13111) +3. Compile and run JabRef `gg.cmd gradle run :jabgui:run` (on Linux and macOS, you need to prefix it with `sh`: `gg.cmd gradle run :jabgui:run`). This will also download the necessary JDK and gradle distribution. In the first run, please give the system about 4 minutes until the GUI is shown. + +Alternatives: + +1. You "just" need a JDK installed to run `./gradlew`: Gradle automatically downloads the JDK +2. You can use the "usual" `git clone`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork. + +**I would like to improve the help page. What are the steps?** + +Please see [How to Improve the Help Page](how-to-improve-the-help-page.md) + +**I would like to help to translate JabRef to another language. How do I get started?** We encourage you to read about [translating the JabRef user interface](how-to-translate-the-ui.md). -**I want to keep Wikipedia pages up-to-date** [![Join the chat at https://gitter.im/JabRef/jabref](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JabRef/jabref) +**I would like to keep Wikipedia pages up-to-date** JabRef improves -- and Wikipedia pages should keep up! @@ -31,7 +63,7 @@ For changes in a specific language, go to the related page, and simply click on If there is no page for your own language, you can easily create one. -**I have some cool feature requests** [![Discourse](https://img.shields.io/badge/discourse-online-green.svg)](https://discourse.jabref.org/c/features/6) +**I have some cool feature requests** [Come discuss it!](http://discourse.jabref.org) @@ -40,8 +72,8 @@ If there is no page for your own language, you can easily create one. Donations keep us going! You can use PayPal or bank transfers. Your institution/company can contribute too, through bank transfer for example. All details are provided at [https://donations.jabref.org](https://donations.jabref.org). Our team consists of volunteers. To provide better support, we are currently trying to get a funded developer on board. Please consider donating money! -{% endtab %} **I would like to contribute code. How to?** Please head to our [Contributing Guide](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md#contributing). + From 86ca87792e84edd9a487fc224836c398e305ee75 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:28:26 +0200 Subject: [PATCH 02/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 9f8ff4d86..f1ef0375d 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -38,7 +38,7 @@ Alternatives: Please see [How to Improve the Help Page](how-to-improve-the-help-page.md) -**I would like to help to translate JabRef to another language. How do I get started?** +**I would like to help translating JabRef to another language.** We encourage you to read about [translating the JabRef user interface](how-to-translate-the-ui.md). From 2ca11502ed857a9efb8dcc2b39cd1983e7b01382 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:28:34 +0200 Subject: [PATCH 03/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index f1ef0375d..3eeb81b5a 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -34,7 +34,7 @@ Alternatives: 1. You "just" need a JDK installed to run `./gradlew`: Gradle automatically downloads the JDK 2. You can use the "usual" `git clone`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork. -**I would like to improve the help page. What are the steps?** +**I would like to improve the help page.** Please see [How to Improve the Help Page](how-to-improve-the-help-page.md) From 4d0c7d22e57f9935b2da137a3b835103f0fd09c5 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:28:51 +0200 Subject: [PATCH 04/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 3eeb81b5a..45a758bcb 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -9,7 +9,7 @@ You can browse all at . The JabRef team really welcomes users to try out these additions and to comment on them. Getting in improvements at this stage is much easier than fixing afterwards. -If you and the command line are friends, then it is very easy to try out pull requests and give feedback. +If you are familiar with the command line on your OS, then it is very easy to try out pull requests and give feedback. In the following, we try to give a minimal set of installation instructions to be able to run a contribution from a fork. Prerequisites: From 24bb48feec9d9f1476cfa276ed010fb714bcd097 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:29:00 +0200 Subject: [PATCH 05/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 45a758bcb..f81089182 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -6,7 +6,7 @@ We are really happy that you are interested in contributing to JabRef. Please ta In JabRef, there are dozens of bug fixes and new features introduced using GitHub's pull request mechansim. You can browse all at . -The JabRef team really welcomes users to try out these additions and to comment on them. +The JabRef team really welcomes users to try out these changes and to comment on them. Getting in improvements at this stage is much easier than fixing afterwards. If you are familiar with the command line on your OS, then it is very easy to try out pull requests and give feedback. From 6269ff7bb85b4d31c7a6133d1613cbaa3e0b0eda Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:29:08 +0200 Subject: [PATCH 06/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index f81089182..1e3f730f6 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -7,7 +7,7 @@ We are really happy that you are interested in contributing to JabRef. Please ta In JabRef, there are dozens of bug fixes and new features introduced using GitHub's pull request mechansim. You can browse all at . The JabRef team really welcomes users to try out these changes and to comment on them. -Getting in improvements at this stage is much easier than fixing afterwards. +Improving on changes in active pull requests is much easier than fixing them later on after their acceptance. If you are familiar with the command line on your OS, then it is very easy to try out pull requests and give feedback. In the following, we try to give a minimal set of installation instructions to be able to run a contribution from a fork. From 23727d434ed2f9794ba18ad46d1fccb57b9c37bc Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:29:17 +0200 Subject: [PATCH 07/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 1e3f730f6..319c82021 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -2,7 +2,7 @@ We are really happy that you are interested in contributing to JabRef. Please take your time to look around here. We especially invite you to look into our [community members page](https://discourse.jabref.org/t/community-members/1868?u=koppor) where members introduce themselves. -**I would like to try out a feature introduced at pull request. What are the steps?** +**I would like to try out a feature introduced at pull request.** In JabRef, there are dozens of bug fixes and new features introduced using GitHub's pull request mechansim. You can browse all at . From 95b360a9eae5ae5e553b826ea6d926daaedcb40e Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:29:24 +0200 Subject: [PATCH 08/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 319c82021..a97e3cbb3 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -14,7 +14,7 @@ In the following, we try to give a minimal set of installation instructions to b Prerequisites: -- [`git`](https://git-scm.com/) - The version control system +- [`git`](https://git-scm.com/) - The version control system. - [GitHubCLI](https://cli.github.com/) - A command-line client to GitHub install it using the installer linked from their [homepage]((https://cli.github.com/)) or [the commands given at the installation hints](https://github.com/cli/cli#installation). - A JabRef project checkout. On Windows, we recommend: - `mkdir c:\git-repositories` From 67ec810f1b5f1d35dc370f3d06a725f06a9fac67 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:30:21 +0200 Subject: [PATCH 09/18] Update en/contributing/README.md Co-authored-by: ThiloteE <73715071+ThiloteE@users.noreply.github.com> --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index a97e3cbb3..19e7cbaf4 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -27,7 +27,7 @@ Try a branch: 1. `cd` into the `JabRef` directory: `cd c:\git-repositories\JabRef` 2. Checkout out the pull request: `gh pr checkout 13111` - where `13111` is the PR number, in this case [pr#13111](https://github.com/JabRef/jabref/pull/13111) -3. Compile and run JabRef `gg.cmd gradle run :jabgui:run` (on Linux and macOS, you need to prefix it with `sh`: `gg.cmd gradle run :jabgui:run`). This will also download the necessary JDK and gradle distribution. In the first run, please give the system about 4 minutes until the GUI is shown. +3. Compile and run JabRef: `gg.cmd gradle run :jabgui:run` (on Linux and macOS, you need to prefix it with `sh`: `gg.cmd gradle run :jabgui:run`). This will also download the necessary JDK and gradle distribution. On the first run, please give the system enough time to accomodate and wait until the JabRef window launches. Depending on your hardware, this may take minutes. Alternatives: From 163564f233ef0bd8146c6c4bf4d00328dc32218f Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:30:39 +0200 Subject: [PATCH 10/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 19e7cbaf4..06a263929 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -15,7 +15,7 @@ In the following, we try to give a minimal set of installation instructions to b Prerequisites: - [`git`](https://git-scm.com/) - The version control system. -- [GitHubCLI](https://cli.github.com/) - A command-line client to GitHub install it using the installer linked from their [homepage]((https://cli.github.com/)) or [the commands given at the installation hints](https://github.com/cli/cli#installation). +- [GitHubCLI](https://cli.github.com/) - A command-line client for GitHub. You can install it using the installer linked on their [homepage]((https://cli.github.com/)) or the commands given at the [installation hints](https://github.com/cli/cli#installation). - A JabRef project checkout. On Windows, we recommend: - `mkdir c:\git-repositories` - `cd c:\git-repositories` From 839060ff0a9be029ad8e08a4b4c6619e529b984c Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:30:46 +0200 Subject: [PATCH 11/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 06a263929..db67b6845 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -16,7 +16,7 @@ Prerequisites: - [`git`](https://git-scm.com/) - The version control system. - [GitHubCLI](https://cli.github.com/) - A command-line client for GitHub. You can install it using the installer linked on their [homepage]((https://cli.github.com/)) or the commands given at the [installation hints](https://github.com/cli/cli#installation). -- A JabRef project checkout. On Windows, we recommend: +- A JabRef project clone. On Windows, we recommend: - `mkdir c:\git-repositories` - `cd c:\git-repositories` - `git clone --recurse-submodules https://github.com/JabRef/jabref.git JabRef` From 22d73118be382a9e905d78936848cc0b9e143010 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:30:54 +0200 Subject: [PATCH 12/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index db67b6845..98d3718a7 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -21,7 +21,7 @@ Prerequisites: - `cd c:\git-repositories` - `git clone --recurse-submodules https://github.com/JabRef/jabref.git JabRef` - `cd JabRef` -- [`gg.cmd`](https://github.com/eirikb/gg) - A cross-platform and cross-architecture version manager. Download [`gg.cmd`](https://github.com/eirikb/gg/releases/latest/download/gg.cmd) and store it in the `JabRef` directory +- [`gg.cmd`](https://github.com/eirikb/gg) - A cross-platform and cross-architecture version manager. Download [`gg.cmd`](https://github.com/eirikb/gg/releases/latest/download/gg.cmd) and store it in the `JabRef` directory. Try a branch: From db18229d6d48a39482a553e82ec76eb3126a93ab Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:34:44 +0200 Subject: [PATCH 13/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 98d3718a7..6715bf029 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -32,7 +32,7 @@ Try a branch: Alternatives: 1. You "just" need a JDK installed to run `./gradlew`: Gradle automatically downloads the JDK -2. You can use the "usual" `git clone`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork. +2. You can use the "usual" `git clone ...`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork. **I would like to improve the help page.** From 69650cc9f2edf166c60ae3420f7a3d5d19c562d8 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:35:53 +0200 Subject: [PATCH 14/18] Update en/contributing/README.md Co-authored-by: Subhramit Basu --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 6715bf029..2562c6156 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -31,7 +31,7 @@ Try a branch: Alternatives: -1. You "just" need a JDK installed to run `./gradlew`: Gradle automatically downloads the JDK +1. You have the project clone ready but "just" need a JDK to run: In the `JabRef directory, execute `./gradlew run`. Gradle automatically downloads the JDK and launches JabRef. 2. You can use the "usual" `git clone ...`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork. **I would like to improve the help page.** From 44ac0bc681059fe9660eb401775e6c87b130c017 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 14:39:48 +0200 Subject: [PATCH 15/18] Fix typo and linting issues on headings. --- en/contributing/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 2562c6156..71f202a71 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -27,7 +27,7 @@ Try a branch: 1. `cd` into the `JabRef` directory: `cd c:\git-repositories\JabRef` 2. Checkout out the pull request: `gh pr checkout 13111` - where `13111` is the PR number, in this case [pr#13111](https://github.com/JabRef/jabref/pull/13111) -3. Compile and run JabRef: `gg.cmd gradle run :jabgui:run` (on Linux and macOS, you need to prefix it with `sh`: `gg.cmd gradle run :jabgui:run`). This will also download the necessary JDK and gradle distribution. On the first run, please give the system enough time to accomodate and wait until the JabRef window launches. Depending on your hardware, this may take minutes. +3. Compile and run JabRef: `gg.cmd gradle run :jabgui:run` (on Linux and macOS, you need to prefix it with `sh`: `gg.cmd gradle run :jabgui:run`). This will also download the necessary JDK and gradle distribution. On the first run, please give the system enough time to accommodate and wait until the JabRef window launches. Depending on your hardware, this may take minutes. Alternatives: @@ -42,7 +42,7 @@ Please see [How to Improve the Help Page](how-to-improve-the-help-page.md) We encourage you to read about [translating the JabRef user interface](how-to-translate-the-ui.md). -**I would like to keep Wikipedia pages up-to-date** +**I would like to keep Wikipedia pages up-to-date.** JabRef improves -- and Wikipedia pages should keep up! @@ -63,7 +63,7 @@ For changes in a specific language, go to the related page, and simply click on If there is no page for your own language, you can easily create one. -**I have some cool feature requests** +**I have some cool feature requests.** [Come discuss it!](http://discourse.jabref.org) @@ -76,4 +76,3 @@ Our team consists of volunteers. To provide better support, we are currently try **I would like to contribute code. How to?** Please head to our [Contributing Guide](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md#contributing). - From d09986f984923175158a491d115655d16cec49c6 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 15:13:59 +0200 Subject: [PATCH 16/18] No installed git needed - only gg.cmd --- .markdownlint.yml | 2 +- en/contributing/README.md | 49 +++++++++++++++++++++++++++++---------- 2 files changed, 38 insertions(+), 13 deletions(-) diff --git a/.markdownlint.yml b/.markdownlint.yml index 4c94a57e6..c69ef1306 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -24,7 +24,7 @@ MD024: false # The FAQs state questions - we allow them MD026: - punctuation: ".,;:!" + punctuation: '.,;:!' MD033: # we have tags with ids diff --git a/en/contributing/README.md b/en/contributing/README.md index 71f202a71..006481292 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -2,7 +2,7 @@ We are really happy that you are interested in contributing to JabRef. Please take your time to look around here. We especially invite you to look into our [community members page](https://discourse.jabref.org/t/community-members/1868?u=koppor) where members introduce themselves. -**I would like to try out a feature introduced at pull request.** +## I would like to try out a feature introduced at pull request. In JabRef, there are dozens of bug fixes and new features introduced using GitHub's pull request mechansim. You can browse all at . @@ -12,27 +12,52 @@ Improving on changes in active pull requests is much easier than fixing them lat If you are familiar with the command line on your OS, then it is very easy to try out pull requests and give feedback. In the following, we try to give a minimal set of installation instructions to be able to run a contribution from a fork. -Prerequisites: +Required tooling: -- [`git`](https://git-scm.com/) - The version control system. - [GitHubCLI](https://cli.github.com/) - A command-line client for GitHub. You can install it using the installer linked on their [homepage]((https://cli.github.com/)) or the commands given at the [installation hints](https://github.com/cli/cli#installation). -- A JabRef project clone. On Windows, we recommend: - - `mkdir c:\git-repositories` - - `cd c:\git-repositories` - - `git clone --recurse-submodules https://github.com/JabRef/jabref.git JabRef` - - `cd JabRef` -- [`gg.cmd`](https://github.com/eirikb/gg) - A cross-platform and cross-architecture version manager. Download [`gg.cmd`](https://github.com/eirikb/gg/releases/latest/download/gg.cmd) and store it in the `JabRef` directory. +- [`gg.cmd`](https://github.com/eirikb/gg) - A cross-platform and cross-architecture version manager. Download [`gg.cmd`](https://github.com/eirikb/gg/releases/latest/download/gg.cmd) and store it in your home (or `Downloads`) directory. + +Initial setup: + +- Windows: + - Open PowerShell + - Switch to a directory containing git repositories. We recommend `c:\git-repositories` + - `mkdir c:\git-repositories` + - `cd c:\git-repositories` + - Get `gg.cmd` + - `wget ggcmd.io -OutFile gg.cmd` + - Clone JabRef + - `./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java JabRef` + - Make `gg.cmd` available in `JabRef` directory + - `cd JabRef` + - `move ..\gg.cmd .` +- Linux: + - Open a shell + - Switch to a directory containing git repositories. We recommend `~/git-repositories` + - `mkdir ~/git-repositories` + - `cd ~/git-repositories` + - Get `gg.cmd` (using either `wget` or `curl`) + - `wget ggcmd.io/gg.cmd` + - Alternative: `curl -L ggcmd.io > gg.cmd` + - Clone JabRef + - `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java JabRef` + - NOTE: You can also use the native git client: `git clone --recurse-submodules https://github.com/JabRef/jabref.git JabRef` for achieving the same result. + - Make `gg.cmd` available in `JabRef` directory + - `cd JabRef` + - `mv ../gg.cmd .` + +Now you are all set: You have a directory `JabRef` containing the recent updates and also `gg.cmd` which you will need later for executing a JabRef build. Try a branch: 1. `cd` into the `JabRef` directory: `cd c:\git-repositories\JabRef` -2. Checkout out the pull request: `gh pr checkout 13111` - where `13111` is the PR number, in this case [pr#13111](https://github.com/JabRef/jabref/pull/13111) +2. Checkout out the pull request: `gh pr checkout 13111` - where `13111` is the PR number, in this case [pr#13111](https://github.com/JabRef/jabref/pull/13111). 3. Compile and run JabRef: `gg.cmd gradle run :jabgui:run` (on Linux and macOS, you need to prefix it with `sh`: `gg.cmd gradle run :jabgui:run`). This will also download the necessary JDK and gradle distribution. On the first run, please give the system enough time to accommodate and wait until the JabRef window launches. Depending on your hardware, this may take minutes. Alternatives: -1. You have the project clone ready but "just" need a JDK to run: In the `JabRef directory, execute `./gradlew run`. Gradle automatically downloads the JDK and launches JabRef. -2. You can use the "usual" `git clone ...`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork. +1. You don't want to use `gg.cmd`: You have the project clone ready and have some Java JDK available: In the `JabRef` directory, execute `./gradlew run`. +2. You don't want to use GitHub's `gh` tool: You can use the "usual" `git clone ...`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork. **I would like to improve the help page.** From 16efe0f0d118f755825ccb51da1bc9a26233b85f Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 15:18:17 +0200 Subject: [PATCH 17/18] Fix () --- en/contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/contributing/README.md b/en/contributing/README.md index 006481292..52002f7d3 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -14,7 +14,7 @@ In the following, we try to give a minimal set of installation instructions to b Required tooling: -- [GitHubCLI](https://cli.github.com/) - A command-line client for GitHub. You can install it using the installer linked on their [homepage]((https://cli.github.com/)) or the commands given at the [installation hints](https://github.com/cli/cli#installation). +- [GitHubCLI](https://cli.github.com/) - A command-line client for GitHub. You can install it using the installer linked on their [homepage](https://cli.github.com/) or the commands given at the [installation hints](https://github.com/cli/cli#installation). - [`gg.cmd`](https://github.com/eirikb/gg) - A cross-platform and cross-architecture version manager. Download [`gg.cmd`](https://github.com/eirikb/gg/releases/latest/download/gg.cmd) and store it in your home (or `Downloads`) directory. Initial setup: From f016446b77ba09d7e0222ca14367c5c7763f6ded Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Fri, 23 May 2025 16:09:39 +0200 Subject: [PATCH 18/18] Discard changes to .markdownlint.yml --- .markdownlint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.markdownlint.yml b/.markdownlint.yml index 6986e96ba..e9bce6e18 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -24,7 +24,7 @@ MD024: false # The FAQs state questions - we allow them MD026: - punctuation: '.,;:!' + punctuation: ".,;:!" MD033: # we have tags with ids