Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,13 @@ Once you have fixed an issue or added a new feature, it is time to submit [a pul
Building MapRoulette Java Client can be simply done using gradle:
`./gradlew clean build`

#### Log4j Properties
#### Log Levels

Make sure you first have a `log4j.properties` file in `src/main/resources`.
Alternatively, you can have as a VM parameter:
The unit tests and integration tests use the `slf4j-simple` logging framework.

```
-Dlog4j.configuration=file://<path_to_config>
```
The log level defaults to `info` and can be changed within the test resources `./src/test/resources/simplelogger.properties`.
Logging at the `trace` level will log all HTTP requests (and payloads) and all HTTP responeses (and payloads).

https://github.com/osmlab/maproulette-java-client/blob/dev/config/log4j/log4j.properties

#### IntelliJ Setup

Expand All @@ -77,6 +74,8 @@ There also is an eclipse code formatting template [here](config/format/code_form

The codebase contains an extensive range of unit tests. Unit tests are supposed to run fairly fast. All the tests will be run for every pull request build, so make sure that it doesn't take an exceptionally long time to run! When contributing new code, make sure to not break existing tests (or modify them and explain why the modification is needed) and to add new tests for new features.

Using the `trace` logging level may help in finding the root cause of a test failure.

### Pull Request Guidelines

Pull requests comments should follow the template below:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The MapRoulette Java Client is a java library that makes it easy to create Proje

### Contributing

For contributing guidelines see [CONTRIBUTING.md](CONTRIBUTING.md).
For contributing guidelines see [CONTRIBUTING.md](CONTRIBUTING.md). These guidelines are essential for anyone providing code contributions.

### API

Expand Down
1 change: 0 additions & 1 deletion dependencies.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ project.ext.packages = [
slf4j: [
api: "org.slf4j:slf4j-api:${versions.slf4j}",
simple: "org.slf4j:slf4j-simple:${versions.slf4j}",
log4j12: "org.slf4j:slf4j-log4j12:${versions.slf4j}",
],
http: "org.apache.httpcomponents:httpclient:${versions.http}",
checkstyle: "com.puppycrawl.tools:checkstyle:${versions.checkstyle}",
Expand Down
2 changes: 2 additions & 0 deletions src/test/resources/simplelogger.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Change the logging level to 'trace' to view all HTTP request data and response data.
org.slf4j.simpleLogger.defaultLogLevel=info