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
+19-20Lines changed: 19 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,11 @@ Improving on changes in active pull requests is much easier than fixing them lat
12
12
If you are familiar with the command line on your OS, then it is very easy to try out pull requests and give feedback.
13
13
In the following, we try to give a minimal set of installation instructions to be able to run a contribution from a fork.
14
14
15
-
Required tooling:
15
+
### Required tooling
16
16
17
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.
18
18
19
-
Initial setup:
19
+
### Initial setup
20
20
21
21
- Windows:
22
22
- Open PowerShell
@@ -48,38 +48,37 @@ Initial setup:
48
48
49
49
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.
50
50
51
-
Try a branch:
51
+
### Try a branch
52
52
53
53
1.`cd` into the `jabref` source directory: `cd c:\git-repositories\jabref`
54
-
2. Checkout out the pull request: `sh ./gg.cmd gh pr checkout 13182` - where `13182` is the PR number, in this case [pr#13182](https://github.com/JabRef/jabref/pull/13182).
55
-
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.
54
+
2. Checkout out the pull request: `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CheckoutPR.java 13182` - where `13182` is the PR number, in this case [pr#13182](https://github.com/JabRef/jabref/pull/13182).
56
55
57
-
On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`.
58
-
59
-
Instead of the number, you can also copy and paste the branch identifier output by GitHub.
56
+
- Instead of the number, you can also copy and paste the branch identifier output by GitHub: `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CheckoutPR.java Yubo-Cao:walkthrough`.
57
+

60
58
61
-

59
+
3. Compile and run JabRef: `sh ./gg.cmd gradle run :jabgui:run`. This will also download the necessary JDK and a 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.
62
60
63
-
In this case, you can run `sh ./gg.cmd gh pr checkout Yubo-Cao:walkthrough`
61
+
On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`.
64
62
65
-
Alternatives:
63
+
#### Alternatives
66
64
67
-
1. In case you don't want to use `gg.cmd`:
65
+
1. In case you don't want to use `gg.cmd`: You can install [JBang](https://www.jbang.dev/) for yourself and execute the commands directly.
66
+
2. In case you don't want to use `JBang`:
68
67
69
68
- You have the project clone ready and have some Java JDK available: In the `JabRef` directory, execute `./gradlew run`.
70
-
- 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).
69
+
- Install `gh` (the [GitHub CLI](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).
71
70
72
-
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.
71
+
3. In case you don't want to use `gh`: You can use the "usual" `git clone ...`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork.
73
72
74
-
**I would like to improve the help page.**
73
+
## I would like to improve the help page
75
74
76
75
Please see [How to Improve the Help Page](how-to-improve-the-help-page.md)
77
76
78
-
**I would like to help to translate JabRef to another language.**
77
+
## I would like to help to translate JabRef to another language
79
78
80
79
We encourage you to read about [translating the JabRef user interface](how-to-translate-the-ui.md).
81
80
82
-
**I would like to keep Wikipedia pages up-to-date.**
81
+
## I would like to keep Wikipedia pages up-to-date
83
82
84
83
JabRef improves -- and Wikipedia pages should keep up!
85
84
@@ -100,16 +99,16 @@ For changes in a specific language, go to the related page, and simply click on
100
99
101
100
If there is no page for your own language, you can easily create one.
102
101
103
-
**I have some cool feature requests.**
102
+
## I have some cool feature requests
104
103
105
104
[Come discuss it!](http://discourse.jabref.org)
106
105
107
-
**Can I make a donation? How?**
106
+
## Can I make a donation? How?
108
107
109
108
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).
110
109
111
110
Our team consists of volunteers. To provide better support, we are currently trying to get a funded developer on board. Please consider donating money!
112
111
113
-
**I would like to contribute code. How to?**
112
+
## I would like to contribute code. How to?
114
113
115
114
Please head to our [Contributing Guide](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md#contributing).
0 commit comments