Contributing

Thanks for being interested in contributing to SEKOIA.IO intake formats. This document describes how to contribute to this repository.

Prerequisites

To contribute to this repository, you will need the following development setup:

A Github account

To fork the repository and create pull requests
Git

To pull the repository and push your changes
Python3

We recommend you to use Python3.10 or higher. To ease python version management, you can use pyenv.
Poetry

To execute helper scripts in the directory utils/

How to contribute

Fork the repository
Clone the repository in local with git clone https://github.com/<my-account>/intake-formats.git .
Create or modify a format. See our documentation to understand how to develop a new format.
Test your changes. See testing to see how to verify your changes.
Lint your files using npx prettier --write <your files> or npx prettier --write . at the root of the repository (How to install Prettier)
Push your changes and create a pull request

Documentation

To understand how to develop a new format, refer to our documentation.

Contribution CheckList

To ensure the quality of contribution, the following points will be reviewed in your changes:

Have clear descriptions for new modules, new formats and taxonomy.
A logo is provided for any new modules and any new formats.
Tests should cover at least 75% of parsers.
At least one smart-description is provide for any new format.