Skip to content

Commit

Permalink
Preliminary contrib guide
Browse files Browse the repository at this point in the history
  • Loading branch information
krasserm committed Jan 4, 2025
1 parent 963b858 commit 9c4f13c
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 35 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
```
36 changes: 1 addition & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

0 comments on commit 9c4f13c

Please sign in to comment.