Contributor Guide

Thank you for your interest in improving this project. This project is open-source under the MIT license and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

• Source Code

• Documentation

• Issue Tracker

• Code of Conduct

How to request a feature or report a bug ?

Request features on the Issue Tracker.

How to set up your development environment

You need Python 3.10+ and the following tools:

• Poetry

• Nox

• nox-poetry

Install the package with development requirements:

$ poetry install

You can now run an interactive Python session, or the command-line interface:

$ poetry run python
$ poetry run cgpt

How to test the project

Run the full test suite:

$ nox

Use Devbox

Devbox is a powerful tool that lets you easily create isolated shells for development.

You need to install Devbox if you do not have it yet.

Then , run this command in the root directory of the project to test the tool :

$ devbox run start

Run this to test the LAN mode :

$ devbox run lan

Run this to test api_key modification :

$ devbox run apikey