Merge tag 'debian/2.10+ds-4'
[debian/jabref.git] / CONTRIBUTING.md
index 8611a87b58d53a37b580267aec2a38baf9de197a..d1efbec138e28ef6a2673b2b3dc403fcfaa06c9b 100644 (file)
@@ -1,21 +1,38 @@
 ## Understanding the basics
-Not sure what a pull request is, or how to submit one?  Take a look at GitHub's excellent [help documentation] first.
+We welcome contributions to JabRef and encourage to create a fork, make a patch, and create a pull request.
+Be sure to create a separate branch for each improvement you implement.
+Take a look at GitHub's excellent [help documentation] for a detailed explanation.
 
+We also have [guidelines for setting up a local workspace](https://github.com/JabRef/jabref/wiki/Guidelines-for-setting-up-a-local-workspace).
 
-## Add your change to the CHANGELOG
+For newcomers, [FLOSS Coach](http://www.flosscoach.com/) might be helpful.
+It contains steps to get start with JabRef development.
+
+Please keep in mind that JabRef relies on Java 6 due to the availability of Java 6 on older Mac OS X operating system.
+
+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).
+
+
+## Formal requirements for a pull request
+
+The main goal of the formal requirements is to provide credit to you and to be able to understand the patch.
+
+### Add your change to the CHANGELOG
 You should edit the [CHANGELOG](CHANGELOG) located in the root directory of the JabRef source.
 Add a line with your changes and your name.
-Nicknames are OK
+Nicknames are OK.
 
 
-## Add yourself to src/main/resources/help/About.html
+### Add yourself to src/main/resources/help/About.html
 We try to keep an updated list of contributors in `About.html`.
 Open `About.html` and add yourself below `Contributions from:`.
 
 
-## Adapt the year in the header
+### Add yourself to the header
 
-The years stated in the header of each .java file should match the years where the file has been modified.
+The headers of each `.java` file state the authors.
+These entries should match the modifications done.
+If you do not want to add your real name, add yourself as `JabRef contriubtors`.
 
 For instance,
 
@@ -26,13 +43,14 @@ For instance,
 gets
 
 ```plain
-/*  Copyright (C) 2003-2014 JabRef contributors.
+/*  Copyright (C) 2003-2011 JabRef contributors.
+ *  Copyright (C) 2015 Stefan Jauch
 ```
 
 
-## Write a good commit message.
+### Write a good commit message
 See [good commit message] or [commit guidelines section of Pro Git].
 
 [commit guidelines section of Pro Git]: http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines
 [good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
-[help documentation]: http://help.github.com/send-pull-requests
+[help documentation]: https://help.github.com/articles/using-pull-requests/