csvbinmatrix 0.5.1

Binary matrix Compressed Sparse Vector
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

# Contributing

## Git workflow

I try to follow this [successful Git branching model](https://nvie.com/posts/a-successful-git-branching-model/).


## Commit

Please use [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/).

VSCode extension `vivaxy.vscode-conventional-commits` can help you to write a conventional commit message.


## Push a new release to crates.io

Please use [cargo-release](https://github.com/crate-ci/cargo-release) to push a new release to [crates.io](https://crates.io/).

From the `develop` branch:
```sh
cargo release patch  # to test and verify what will automaticaly change
```
When you have verified all the changes and fix the `cargo release` errors:
```sh
cargo release --execute
```

Then to respect [the Git workflow](#git-workflow):
```sh
# You are still on the `develop` branch
git checkout main
git merge --no-ff v0.1.0  # if the created tag is `v0.1.0`
git push origin main --follow-tags
```


## Testing

### Install dependencies

* [cargo-nextest](https://nexte.st/)
* [cargo-llvm-cov](https://crates.io/crates/cargo-llvm-cov)
    ```bash
    cargo install cargo-llvm-cov
    ```

### Generate report on terminal

At the workspace root:
```bash
cargo nextest run
```

### Generating coverage

See at the beginning of the bellow script the packages to install.

At the workspace root:

```bash
./coverage.sh
cargo llvm-cov --open # open HTML report into the navigator
```

It also generates a `.lcov.info` lcov file.