Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kertu Hiire authored Sep 27, 2017
1 parent 90e8f80 commit 9092e45
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Introduction

This repository is one of the main components of the RIHA infrastructure. RIHA is being maintained and developed by Estonian Information System Authority.

## Prerequisits of submitting a change in RIHA-Browser

- Your code is reasonably covered with unit tests
- Your code has been tested
- RIHA-Browser's API description (swagger.yaml) has been updated

Updating the API description is automated and should be regenerated before each merge/pull request. API descriptions are generated using a [swagger maven plugin](https://github.com/kongchen/swagger-maven-plugin) which uses annotations in Java code to generate a new desciption. To run the generation, use
`mvn swagger:generate` which will generate a swagger.yaml file in `src/main/resources/static` folder.

0 comments on commit 9092e45

Please sign in to comment.