From 9c4f13c7fb3c9fb57f0a588cc790d17c2c5dbf29 Mon Sep 17 00:00:00 2001 From: Martin Krasser Date: Sat, 4 Jan 2025 12:05:53 +0100 Subject: [PATCH] Preliminary contrib guide --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ README.md | 36 +----------------------------------- 2 files changed, 40 insertions(+), 35 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aecbf04 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +**This guide is work in progress ...** + +Clone the repository: + +```bash +git clone https://github.com/gradion-ai/freeact-skills.git +cd freeact-skills +``` + +Create a new Conda environment and activate it: + +```bash +conda env create -f environment.yml +conda activate freeact-skills +``` + +Install dependencies with Poetry: + +```bash +poetry install --all-extras --with docs +``` + +Install pre-commit hooks: + +```bash +invoke precommit-install +``` + +Enforce coding conventions (done automatically by pre-commit hooks): + +```bash +invoke cc +``` + +Run tests: + +```bash +pytest -s tests +``` diff --git a/README.md b/README.md index ceafa78..0abfe0b 100644 --- a/README.md +++ b/README.md @@ -4,38 +4,4 @@ The `freeact-skills` project provides a curated set of predefined skill modules ## Documentation -The official documentation is available [here](https://gradion-ai.github.io/freeact-skills/). - -## Development - -Clone the repository: - -```bash -git clone https://github.com/gradion-ai/freeact-skills.git -cd freeact-skills -``` - -Create a new Conda environment and activate it: - -```bash -conda env create -f environment.yml -conda activate freeact-skills -``` - -Install dependencies with Poetry: - -```bash -poetry install --all-extras --with docs -``` - -Install pre-commit hooks: - -```bash -invoke precommit-install -``` - -Run tests: - -```bash -pytest -s tests -``` +The `freeact-skills` documentation is available [here](https://gradion-ai.github.io/freeact-skills/).