You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en/contributing/README.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
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.
4
4
5
-
## I would like to try out a feature introduced at pull request.
5
+
## I would like to try out a feature introduced at pull request
6
6
7
7
In JabRef, there are dozens of bug fixes and new features introduced using GitHub's pull request mechansim.
8
8
You can browse all at <https://github.com/JabRef/jabref/pulls>.
@@ -14,7 +14,6 @@ In the following, we try to give a minimal set of installation instructions to b
14
14
15
15
Required tooling:
16
16
17
-
-[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).
18
17
-[`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.
@@ -50,14 +49,20 @@ Now you are all set: You have a directory `JabRef` containing the recent updates
50
49
51
50
Try a branch:
52
51
53
-
1.`cd` into the `JabRef` directory: `cd c:\git-repositories\JabRef`
54
-
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).
55
-
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.
52
+
1.`cd` into the `jabref` directory: `cd c:\git-repositories\jabref`
53
+
2. Checkout out the pull request: `sh ./gg.cmd gh pr checkout 13111` - where `13111` is the PR number, in this case [pr#13111](https://github.com/JabRef/jabref/pull/13111).
54
+
3. Compile and run JabRef: `sh ./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.
55
+
56
+
On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`.
56
57
57
58
Alternatives:
58
59
59
-
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`.
60
-
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.
60
+
1. In case you don't want to use `gg.cmd`:
61
+
62
+
- You have the project clone ready and have some Java JDK available: In the `JabRef` directory, execute `./gradlew run`.
63
+
- Install [GitHubCLI](https://cli.github.com/), a command-line client for GitHub by 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).
64
+
65
+
2. In case 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.
0 commit comments