update filenames
[debian/jabref.git] / CONTRIBUTING.md
1 ## Understanding the basics
2 We welcome contributions to JabRef and encourage to create a fork, make a patch, and create a pull request.
3 Be sure to create a separate branch for each improvement you implement.
4 Take a look at GitHub's excellent [help documentation] for a detailed explanation.
5
6 We also have [guidelines for setting up a local workspace](https://github.com/JabRef/jabref/wiki/Guidelines-for-setting-up-a-local-workspace).
7
8 For newcomers, [FLOSS Coach](http://www.flosscoach.com/) might be helpful.
9 It contains steps to get start with JabRef development.
10
11 Please keep in mind that JabRef relies on Java 6 due to the availability of Java 6 on older Mac OS X operating system.
12
13 In case you have any questions, you can use our [GITTER channel](https://gitter.im/JabRef/jabref) or use our [developers mailinglist](https://lists.sourceforge.net/lists/listinfo/jabref-devel).
14
15
16 ## Formal requirements for a pull request
17
18 The main goal of the formal requirements is to provide credit to you and to be able to understand the patch.
19
20 ### Add your change to the CHANGELOG
21 You should edit the [CHANGELOG](CHANGELOG) located in the root directory of the JabRef source.
22 Add a line with your changes and your name.
23 Nicknames are OK.
24
25
26 ### Add yourself to src/main/resources/help/About.html
27 We try to keep an updated list of contributors in `About.html`.
28 Open `About.html` and add yourself below `Contributions from:`.
29
30
31 ### Add yourself to the header
32
33 The headers of each `.java` file state the authors.
34 These entries should match the modifications done.
35 If you do not want to add your real name, add yourself as `JabRef contriubtors`.
36
37 For instance,
38
39 ```plain
40 /*  Copyright (C) 2003-2011 JabRef contributors.
41 ```
42
43 gets
44
45 ```plain
46 /*  Copyright (C) 2003-2011 JabRef contributors.
47  *  Copyright (C) 2015 Stefan Jauch
48 ```
49
50
51 ### Write a good commit message
52 See [good commit message] or [commit guidelines section of Pro Git].
53
54 [commit guidelines section of Pro Git]: http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines
55 [good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
56 [help documentation]: https://help.github.com/articles/using-pull-requests/