Skip to content

Commit b5f3cec

Browse files
authored
Add howto for local clone
1 parent 56ad253 commit b5f3cec

File tree

1 file changed

+39
-7
lines changed

1 file changed

+39
-7
lines changed

en/contributing/README.md

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,48 @@
1-
# Contribute to JabRef
1+
# Contribute to JabRef [![Join the chat at https://gitter.im/JabRef/jabref](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JabRef/jabref)
22

33
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.
44

5-
**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)
5+
**I would like to try out a feature introduced at pull request. What are the steps?**
66

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.
811

9-
**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)
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:
20+
- `mkdir c:\git-repositories`
21+
- `cd c:\git-repositories`
22+
- `git clone --recurse-submodules https://github.com/JabRef/jabref.git JabRef`
23+
- `cd JabRef`
24+
- [`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?**
1042

1143
We encourage you to read about [translating the JabRef user interface](how-to-translate-the-ui.md).
1244

13-
**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)
45+
**I would like to keep Wikipedia pages up-to-date**
1446

1547
JabRef improves -- and Wikipedia pages should keep up!
1648

@@ -31,7 +63,7 @@ For changes in a specific language, go to the related page, and simply click on
3163

3264
If there is no page for your own language, you can easily create one.
3365

34-
**I have some cool feature requests** [![Discourse](https://img.shields.io/badge/discourse-online-green.svg)](https://discourse.jabref.org/c/features/6)
66+
**I have some cool feature requests**
3567

3668
[Come discuss it!](http://discourse.jabref.org)
3769

@@ -40,8 +72,8 @@ If there is no page for your own language, you can easily create one.
4072
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).
4173

4274
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 %}
4475

4576
**I would like to contribute code. How to?**
4677

4778
Please head to our [Contributing Guide](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md#contributing).
79+

0 commit comments

Comments
 (0)