CONTRIBUTING.md

Contribution Guidelines

Thank you for considering contributing to this project! Contributions are always welcome and appreciated.

How to Contribute

Please check the issue tracker to see if there is an issue you would like to work on or if it has already been resolved.

Reporting Bugs

1. Open an issue on the issue tracker.
2. Include information such as steps to reproduce the observed behavior and relevant logs or screenshots.

Suggesting Features

1. Open an issue on the issue tracker.
2. Provide details about the feature, its purpose, and potential implementation ideas.

Submitting Pull Requests

• Make sure all tests pass before submitting a pull request.
• Write a clear description of the changes you made and the reasons behind them.

Development Workflow

Prerequisites

• Node.js >=20.0.0
• npm or yarn for package management
• GNU Make
• Python >=3.10 and pip for installing pre-commit

Development Setup

1. Install dependencies:

   make install
   

   This will install the necessary Node.js dependencies.

2. Set up Git hooks:

   make setup-hooks
   

   This will set up pre-commit hooks for linting and formatting.

Code Style

• Use the make format command to format the code.

Running Tests

• Use the make test command to run the tests.

Running Linter Checks

• Use the make lint command to run the linter checks.

See Available Commands

• Run make help to see all available commands for managing different tasks.

Code of Conduct

We adhere to the project's Code of Conduct.