Contributing to dabeplech

You have many different ways to contribute to dabeplech:

• Add new API connectors

• Report a Bug

• Suggesting a new Feature

• Update the Documentation

• Participate to the discussions in the Github issues

Note

For more advanced features, such as the code architecture, we encourage to go through discussions on GitHub before starting any major changes or contributions.

General rules

• Development environment: set up your environment to contribute.

• Contribution Flow: contribution through GitHub.

• Code of Conduct

Adding a new API connector

For the moment, we identify three different scenarios when adding a new API connector:

API already returning JSON

This is the most simple case where you just need to add a new connector:

1. Adding an API returning JSON

2. Completing the Documentation

API returning different format

1. Model description of the response

2. Parsers

3. Adding an API based on a Parser

4. Completing the Documentation

Build API connector from scrapping

1. Model description of the response

2. contrib_scrapper

3. Adding an API based on a Scrapper

4. Completing the Documentation