8611a87b58d53a37b580267aec2a38baf9de197a
[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
5 ## Add your change to the CHANGELOG
6 You should edit the [CHANGELOG](CHANGELOG) located in the root directory of the JabRef source.
7 Add a line with your changes and your name.
8 Nicknames are OK
9
10
11 ## Add yourself to src/main/resources/help/About.html
12 We try to keep an updated list of contributors in `About.html`.
13 Open `About.html` and add yourself below `Contributions from:`.
14
15
16 ## Adapt the year in the header
17
18 The years stated in the header of each .java file should match the years where the file has been modified.
19
20 For instance,
21
22 ```plain
23 /*  Copyright (C) 2003-2011 JabRef contributors.
24 ```
25
26 gets
27
28 ```plain
29 /*  Copyright (C) 2003-2014 JabRef contributors.
30 ```
31
32
33 ## Write a good commit message.
34 See [good commit message] or [commit guidelines section of Pro Git].
35
36 [commit guidelines section of Pro Git]: http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines
37 [good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
38 [help documentation]: http://help.github.com/send-pull-requests