rust-template-test 0.1.1

A Rust template for test
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

# Contribution guidelines

First off, thank you for considering contributing to tui-scrollview.

If your contribution is not straightforward, please first discuss the change you wish to make by
creating a new issue before making the change.

## Reporting issues

Before reporting an issue on the [issue tracker](https://github.com/joshka/tui-scrollview/issues),
please check that it has not already been reported by searching for some related keywords.

## Pull requests

Try to do one pull request per change.

## Commit Message Format

This project adheres to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
A specification for adding human and machine readable meaning to commit messages.

### Commit Message Header

```plain
<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope
  │
  └─⫸ Commit Type: feat|fix|build|ci|docs|perf|refactor|test|chore
```

#### Type

| feat                                                | Features                 | A new feature                                                                               |
| --------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------- |
| fix                                                 | Bug Fixes                | A bug fix                                                                                   |
| docs                                                | Documentation            | Documentation only changes                                                                  |
| style                                               | Styles                   | Changes that do not affect the meaning of the code\                                         |
| (white-space, formatting, missing semi-colons, etc) |
| refactor                                            | Code Refactoring         | A code change that neither fixes a bug nor adds a feature                                   |
| perf                                                | Performance Improvements | A code change that improves performance                                                     |
| test                                                | Tests                    | Adding missing tests or correcting existing tests                                           |
| build                                               | Builds                   | Changes that affect the build system or external dependencies (example scopes: main, serde) |
| ci                                                  | Continuous Integrations  | Changes to our CI configuration files and scripts (example scopes: Github Actions)          |
| chore                                               | Chores                   | Other changes that don't modify src or test files                                           |
| revert                                              | Reverts                  | Reverts a previous commit                                                                   |

## Developing

### Set up

This is no different than other Rust projects.

```shell
git clone https://github.com/joshka/tui-scrollview
cd tui-scrollview
cargo test
```

### Useful Commands

- Run Clippy:

  ```shell
  cargo clippy --all-targets --all-features --workspace
  ```

- Run all tests:

  ```shell
  cargo test --all-features --workspace
  ```

- Check to see if there are code formatting issues

  ```shell
  cargo fmt --all -- --check
  ```

- Format the code in the project

  ```shell
  cargo fmt --all
  ```