Skip to content

Commit

Permalink
CONTRIBUTING: Code formatter is no longer (#2537)
Browse files Browse the repository at this point in the history
* Removed a sentence in CONTRIBUTING about the discontinued gradle format plugin

* Just some additional proof-reading.
  • Loading branch information
LinusDietz authored and tobiasdiez committed Feb 11, 2017
1 parent 3669fab commit 1d3758b
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Understanding the basics
We welcome contributions to JabRef and encourage to create a fork, clone, **create a new branch** (such as `fix-for-issue-121`), **work on the new branch - not master**, and create a pull request.
We welcome contributions to JabRef and encourage to create a fork, clone, **create a new branch** (such as `fix-for-issue-121`), **work on the new branch not master**, 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.

Expand All @@ -19,7 +19,6 @@ Nevertheless we aim to keep the code consistently formatted, therefore we additi
### Ensure consistent formatting
Ensure your code is formatted according the JabRef formatting guidelines.
When you use Eclipse, the required configuration is generated automatically by `gradlew cleanEclipse eclipse`.
You can also run `gradlew format` to let the [Gradle Format plugin](https://github.com/youribonnaffe/gradle-format-plugin) do the formatting.


### Add your change to CHANGELOG.md
Expand Down Expand Up @@ -92,14 +91,14 @@ because <additional rationale>.


### When adding a new Localization.lang entry
Add new Localization.lang("KEY") to Java file.
Add new `Localization.lang("KEY")` to Java file.
Tests fail. In the test output a snippet is generated which must be added to the English translation file. There is also a snippet generated for the non-English files, but this is irrelevant.
Add snippet to English translation file located at `src/main/resources/l10n/JabRef_en.properties`
With `gradlew localizationUpdate` the "KEY" is added to the other translation files as well.
Tests are green again.

You can also directly run the specific test in your IDE. The test "LocalizationConsistencyTest" is placed under `src/test/java/net.sf.jabref.logic.l10n/LocalizationConsistencyTest.java`
Find more information in the [JabRef Wiki](https://github.com/JabRef/jabref/wiki/Code-Howtos#using-localization-correctly)
Find more information in the [JabRef Wiki](https://github.com/JabRef/jabref/wiki/Code-Howtos#using-localization-correctly).


### Create a pull request
Expand Down

0 comments on commit 1d3758b

Please sign in to comment.