agentsql 0.2.0

Interface for agent sql persistence
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

# Contributing to agentsql
First off, thank you for considering contributing to agentsql. 
It's people like you that make agentsql great!


## Getting Started

### 1. Fork the Project
Start by forking the repository and then clone your fork.

```bash
git clone https://github.com/cryptopatrick/agentsql.git
cd agentsql
```

### 2. Install Rust
If you haven't already, install Rust by following the instructions [here](https://www.rust-lang.org/tools/install).

### 3a. Install tools
If you haven't already, install Just by following the instrutions [here](https://github.com/casey/just).

Install tools by running `install-required`, `install-recommended` or `install-all'

```bash
just install-all
```

### 3b. Running and Testing

To run agentsql, piping the output into [bunyan](https://github.com/LukeMathWalker/bunyan) to format outputted the structured logs:

```bash
cargo run | bunyan
```

To run the tests:

```bash
cargo test
```

### 4. Create a Branch
Create a branch for your new feature or bug fix:

```bash
git checkout -b YOUR_USERNAME/your-new-feature
```

## Coding Guidelines
Please adhere to the following guidelines:

- Follow the [Rust Coding Guidelines](https://rust-lang.github.io/api-guidelines/about.html).
- Write tests for new features.
- Keep commits small and focused.
- Update the documentation as needed.

## Submitting a Pull Request
1. Push your changes to your fork:

```bash
git push origin YOUR_USERNAME/your-new-feature
```

2. [Submit a pull request](https://github.com/cryptopatrick/agentsql/pulls) to the original repository.

3. Please include a clear and descriptive title and a detailed explanation of your changes in the pull request description.

4. Link any relevant issues in your pull request description.

## Reporting Issues
Please use the [issue tracker](https://github.com/cryptopatrick/agentsql/issues) to report any bugs or request new features.

## Licensing
By contributing, you agree that your contributions will be licensed under the same license as the original project MIT.

## Questions?
Feel free to reach out to the maintainers or open an issue. 
Always happy to help!

Thank you for contributing to agentsql!