farg 0.4.5

A Rust library for colorimetry, color space conversions, and color manipulation.
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

# Contributing to Farg

Thank you for your interest in contributing to Farg. This guide will help you get started with
development.

## Quick Start

```bash
# Install mise (recommended)
curl https://mise.run | sh

# Install toolchain and run all checks
mise install
mise run check

# Run tests
mise run test

# Format and lint
mise run format
mise run lint
```

Without mise, run scripts directly from `tasks/`:

```bash
./tasks/check
./tasks/test
./tasks/format/rust
./tasks/lint/rust
```

## Development Workflow

1. Create a branch for your changes
2. Make your changes following the [code style guide][code-style]
3. Run `mise run check` to verify everything passes
4. Submit a pull request

## Common Tasks

| Task           | Command               | Description                    |
|----------------|-----------------------|--------------------------------|
| Check          | `mise run check`      | Verify compilation             |
| Test           | `mise run test`       | Run tests with coverage        |
| Format         | `mise run format`     | Format all files               |
| Lint           | `mise run lint`       | Lint all files                 |
| Audit          | `mise run audit`      | Check for vulnerabilities      |

Filter tests: `mise run test -- --filter xyz`

## Guides

| Guide                      | Topics                                 |
|----------------------------|----------------------------------------|
| [Development Tasks][tasks] | Available commands and toolchain       |
| [Code Style][code-style]   | Formatting, linting, code organization |
| [Testing][testing]         | Test structure and conventions         |

## Documentation

- [Design Documents][design] - Architecture decisions and design rationale
- [Process Guide][process] - ADR and RFC workflows for proposing changes

[code-style]: https://github.com/aaronmallen/farg/blob/main/docs/dev/code-style.md
[design]: https://github.com/aaronmallen/farg/blob/main/docs/design/README.md
[process]: https://github.com/aaronmallen/farg/blob/main/docs/process/README.md
[tasks]: https://github.com/aaronmallen/farg/blob/main/docs/dev/tasks.md
[testing]: https://github.com/aaronmallen/farg/blob/main/docs/dev/testing.md