duck-diagnostic 0.1.0

Generic diagnostic engine for building rich error reporting into any tool
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

# Contributing to gentleduck/diagnostic

Thank you for considering contributing to **gentleduck/diagnostic**.
We welcome all kinds of contributions - bug reports, documentation improvements, feature requests, and code.

---

## Code of Conduct

By participating in this project, you agree to uphold our [Code of Conduct](./CODE_OF_CONDUCT.md).
Please treat everyone with respect and kindness.

---

## Getting Started

### 1. Fork & Clone

```bash
git clone https://github.com/gentleduck/duck-diagnostic.git
cd duck-diagnostic
```

### 2. Build

```bash
cargo build
```

### 3. Run Tests

```bash
cargo test
```

### 4. Run Examples

```bash
cargo run --example demo
```

---

## Development Workflow

1. **Branching**

   * Create a new branch from `master`.
   * Use a descriptive name, e.g. `fix/underline-offset`, `feat/multi-line-spans`, `docs/readme-update`.

   ```bash
   git checkout -b feat/my-feature
   ```

2. **Coding Standards**

   * Run `cargo fmt` before committing.
   * Run `cargo clippy` and fix any warnings.
   * Write clear, self-documenting code.

3. **Commit Messages**

   Follow [Conventional Commits](https://www.conventionalcommits.org/):

   ```
   feat: add multi-line span support
   fix: correct underline alignment in plain text mode
   docs: update api reference in readme
   ```

4. **Testing**

   * Write tests for new functionality.
   * Run all tests before pushing:

     ```bash
     cargo test
     ```

---

## Submitting a Pull Request

1. Push your branch:

   ```bash
   git push origin feat/my-feature
   ```

2. Open a Pull Request against the `master` branch.

3. Fill out the PR template with:

   * A clear description of your changes
   * Any related issues (`Closes #123`)
   * How you tested it

---

## Reporting Issues

If you find a bug, please [open an issue](https://github.com/gentleduck/duck-diagnostic/issues) with:

* Steps to reproduce
* Expected behavior
* Actual behavior
* Rust version (`rustc --version`)

---

## Ways to Contribute

* **Code**: Bug fixes, features, optimizations
* **Docs**: README improvements, examples, guides
* **Testing**: More test coverage, edge cases
* **Community**: Helping others in discussions

---

## License

By contributing, you agree that your contributions will be licensed under the project's [MIT License](./LICENSE).