Imported Upstream version 2.11~beta2+ds
[debian/jabref.git] / CONTRIBUTING.md
1 ## Understanding the basics
2 Not sure what a pull request is, or how to submit one?  Take a look at GitHub's excellent [help documentation] first.
3
4 We also have [guidelines for setting up a local workspace](https://github.com/JabRef/jabref/wiki/Guidelines-for-setting-up-a-local-workspace).
5
6
7 ## Add your change to the CHANGELOG
8 You should edit the [CHANGELOG](CHANGELOG) located in the root directory of the JabRef source.
9 Add a line with your changes and your name.
10 Nicknames are OK
11
12
13 ## Add yourself to src/main/resources/help/About.html
14 We try to keep an updated list of contributors in `About.html`.
15 Open `About.html` and add yourself below `Contributions from:`.
16
17
18 ## Adapt the year in the header
19
20 The years stated in the header of each .java file should match the years where the file has been modified.
21
22 For instance,
23
24 ```plain
25 /*  Copyright (C) 2003-2011 JabRef contributors.
26 ```
27
28 gets
29
30 ```plain
31 /*  Copyright (C) 2003-2014 JabRef contributors.
32 ```
33
34
35 ## Write a good commit message.
36 See [good commit message] or [commit guidelines section of Pro Git].
37
38 [commit guidelines section of Pro Git]: http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines
39 [good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
40 [help documentation]: http://help.github.com/send-pull-requests