Soft skills required
- JabRef main page: good to learn about the project - http://www.jabref.org
- JabRef Github page: you will find a readme and the JabRef code in Github social coding service - https://github.com/JabRef/jabref
- JabRef issue tracker: https://github.com/jabref/jabref/issues
- OpenHub URL: https://www.openhub.net/p/jabref
Technical skills required
About the project
JabRef is written in the programming language Java. This means that it will run on most computer platforms, including Windows, Mac and Linux. It is open source, which means that source code must always be available. The specific license used in JabRef is the GNU Public License and some components are licensed under the Lesser Gnu Public License. Basically, JabRef is a non-profit venture, so don't expect to get paid for your coding efforts. You can make money on JabRef by providing support services.
How to start
Please consider the flow below if you want to be guided till you finish your contribution. It is not a strict flow, you can skip steps if you want. It was designed to give you a sense on what you should do. You can move to appropriate guidelines and resource by clicking the boxes instead of using the menu.
Here you can see the issues labeled as "asking for a pull request" by JabRef team:
Use the comments to inform the community you are working on that task and also to get support/ask for help
Finding Mentorship and Support
Searching the mailing list
Before asking, what about lurking a bit?
Try to search mailing list archives, and wiki before placing your own question. It is a
good practice to try to find information yourself before asking.
Search mailing list archives:
Search project site
No IRC Channel is available for this project. Please use the developers mailing list
Information about mailing list
Joining the Forum
OK! If you did not find any solution for your problem or prefer to send a message/question to the community, move on
JabRef community has a Discourse Forum set at http://discourse.jabref.org/
If it is the first messahe you are sending, please: be polite, the community is made of volunteers present yourself identify yourself as a newcomer present your motivations and your goals show you tried to solve the issue and to find the solution ask your question directly send a meaningful and correct message (request someone to review the English if you are not confident)
Resources provided by the project
You can use the following tutorial to setup your workspace
** JabRef uses Gradle to manage library dependencies and building process
Search for solutions in the mailing list and forum
Submitting your contribution
WHEN SENDING A PULL REQUEST: Write a nice Pull-request message, explaining what is the reason of your pull-request, and informing you followed the guidelines provided in the CONTRIBUTING.md file.
JabRef is now hosted by Github. It follows the "Fork and Pull" approach, as other GitHub Projects. To learn more, you can check Github help page:
- Using Pull Requests/Fork and Pull model - https://help.github.com/articles/using-pull-requests
Lastly, fix the issues raised during the review of your pull request
Do not forget to follow CONTRIBUTING.md.
- Add your entry to https://github.com/JabRef/jabref/blob/master/CHANGELOG
- Add yourself to src/main/resources/help/About.html
- Update the list of contributors in About.html. Open About.html and add yourself below "Contributions from:"
- Adapt the year in the header, changing the last year to the current year