cargo-sync-rdme 0.8.0

Cargo subcommand to synchronize README with crate 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

# Contribution Guidelines

First off, thank you for considering contributing to `cargo-sync-rdme`.

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/gifnksm/cargo-sync-rdme/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.

### Updating the Changelog

Add your changes to the **Unreleased** section of [CHANGELOG](https://github.com/gifnksm/cargo-sync-rdme/blob/main/CHANGELOG.md).

Add the changes from your pull request to one of the following subsections,
depending on the types of changes defined by
[Keep a changelog](https://keepachangelog.com/en/1.0.0/):

* `Added` for new features.
* `Changed` for changes in existing functionality.
* `Deprecated` for soon-to-be removed features.
* `Removed` for now removed features.
* `Fixed` for any bug fixes.
* `Security` in case of vulnerabilities.

If the required subsection does not exist yet under **Unreleased**, create it!

## Developing

If you want to contribute to the development of `cargo-sync-rdme`, you can follow the steps below.

### Setup

This is no different than other Rust projects.

```console
git clone https://github.com/gifnksm/cargo-sync-rdme
cd cargo-sync-rdme
```

### Useful Commands

* Build and run release version:

  ```console
  cargo build --release && cargo run --release
  ```

* Run all CI checks:

  ```console
  mise run ci
  ```

See `mise tasks ls` for more commands.