Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 898 Bytes

CONTRIBUTE.md

File metadata and controls

24 lines (17 loc) · 898 Bytes

How to contribute

Any contribution is appreciated. In order to contribute, create a pull request to the main branch of this repository.

API-documentation

  1. Textual description of the main functionality of the API
  2. Swagger-link
  3. Example requests
  4. Example response
  5. Link to getting-started example(s)
  6. Link to code_and_tutorial

Tutorials and code examples

Tutorials and code examples should aim at being easy and understandable for developers of any competence level. Try to make things as easy as possible to follow for the reader.

  1. Name the folder in a descriptive way such as: "Getting started - maptiles in leaflet.js"
  2. The README.md file should at a minimum contain
    1. Link(s) to the relevant API documentation folders
    2. Textual description of the purpose of the tutorial/example
    3. Code example
    4. Preferably link to a working example / code