Skip to content

Commit 1ea7ac5

Browse files
committed
docs: add content
1 parent 9588d02 commit 1ea7ac5

3 files changed

Lines changed: 29 additions & 0 deletions

File tree

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Coding Standards
2+
3+
OpenLRW follows the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) for having a better open source experience.
4+

docs/en/developer/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Developer Guide
2+
Contributing to the open source project.
3+
4+
* Contributor Guidelines
5+
* Coding Standards
6+
* Using Maven for development purposes
7+
* [Automated Tests](tests.md)
8+
* Run OpenLRW through Docker
9+
* Access to Swagger
10+
* Helpers

docs/en/developer/tests.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Automated Tests
2+
3+
[Spring JUnit](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-testing.html) is used to run automated tests on OpenLRW when building the executable.
4+
5+
All the tests are located in the `src/test` directory.
6+
7+
## Running the tests
8+
9+
Execute the following command to execute Unit and Integration tests : `mvn test`
10+
11+
12+
## Continuous Integration with Travis-CI
13+
After each commit pushed on the main repository, unit tests are executed on an Oracle JDK 8 Virtual Machine.
14+
15+
The Travis config file `.travis.yml` is located on the root directory of OpenLRW.

0 commit comments

Comments
 (0)