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
+39-7Lines changed: 39 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,48 @@
1
-
# Contribute to JabRef
1
+
# Contribute to JabRef[](https://gitter.im/JabRef/jabref)
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 improve the help page. What are the steps?**[](https://gitter.im/JabRef/jabref)
5
+
**I would like to try out a feature introduced at pull request. What are the steps?**
6
6
7
-
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).
7
+
In JabRef, there are dozens of bug fixes and new features introduced using GitHub's pull request mechansim.
8
+
You can browse all at <https://github.com/JabRef/jabref/pulls>.
9
+
The JabRef team really welcomes users to try out these additions and to comment on them.
10
+
Getting in improvements at this stage is much easier than fixing afterwards.
8
11
9
-
**I would like to help to translate JabRef to another language. How do I get started?**[](https://gitter.im/JabRef/jabref)
12
+
If you and the command line are friends, then it is very easy to try out pull requests and give feedback.
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
+
15
+
Prerequisites:
16
+
17
+
-[`git`](https://git-scm.com/) - The version control system
18
+
-[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).
19
+
- A JabRef project checkout. On Windows, we recommend:
-[`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
25
+
26
+
Try a branch:
27
+
28
+
1.`cd` into the `JabRef` directory: `cd c:\git-repositories\JabRef`
29
+
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)
30
+
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.
31
+
32
+
Alternatives:
33
+
34
+
1. You "just" need a JDK installed to run `./gradlew`: Gradle automatically downloads the JDK
35
+
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.
36
+
37
+
**I would like to improve the help page. What are the steps?**
38
+
39
+
Please see [How to Improve the Help Page](how-to-improve-the-help-page.md)
40
+
41
+
**I would like to help to translate JabRef to another language. How do I get started?**
10
42
11
43
We encourage you to read about [translating the JabRef user interface](how-to-translate-the-ui.md).
12
44
13
-
**I want to keep Wikipedia pages up-to-date**[](https://gitter.im/JabRef/jabref)
45
+
**I would like to keep Wikipedia pages up-to-date**
14
46
15
47
JabRef improves -- and Wikipedia pages should keep up!
16
48
@@ -31,7 +63,7 @@ For changes in a specific language, go to the related page, and simply click on
31
63
32
64
If there is no page for your own language, you can easily create one.
33
65
34
-
**I have some cool feature requests**[](https://discourse.jabref.org/c/features/6)
66
+
**I have some cool feature requests**
35
67
36
68
[Come discuss it!](http://discourse.jabref.org)
37
69
@@ -40,8 +72,8 @@ If there is no page for your own language, you can easily create one.
40
72
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).
41
73
42
74
Our team consists of volunteers. To provide better support, we are currently trying to get a funded developer on board. Please consider donating money!
43
-
{% endtab %}
44
75
45
76
**I would like to contribute code. How to?**
46
77
47
78
Please head to our [Contributing Guide](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md#contributing).
0 commit comments