Skip to content

Commit 469af9e

Browse files
author
Sven Lechner
committed
chore(readme): add basic readme description
1 parent 2363d01 commit 469af9e

File tree

1 file changed

+2
-23
lines changed

1 file changed

+2
-23
lines changed

README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,8 @@
1-
# zerotask-rust-lib-template
1+
# conventional-commits-types
22

33
[![docs_master_badge]][docs_master_url]
44

5-
> A GitHub template for Rust libraries.
6-
7-
## Features
8-
9-
- Continuous Integration through GitHub Actions
10-
- Each PR is tested by running the following commands to ensure that only working code is added to the repository:
11-
- `cargo fmt` to ensure uniform source code formatting.
12-
- `cargo clippy` to use more idiomic Rust code, optimize code as well as prevent hard to spot bugs.
13-
- `cargo check` to ensure that the library compiles properly.
14-
- `cargo test` to ensure that the library works as expected.
15-
- Each push to master triggers the following:
16-
- Generation of the newest documentation that gets pushed to the `gh-pages` branch.
17-
- MSRV (**M**inimal **s**upported **R**ust **v**ersion)
18-
- Kept in sync with the latest available Rust version on Ubuntu.
19-
- Opinioded `rustfmt` configuration file.
20-
- Misc
21-
- `.editorconfig` file for code-unrelated files.
22-
- Ensures proper formatting for workflow files and other configuration files.
23-
24-
## Current Properties
25-
26-
- MSRV: 1.41.0
5+
> A library defining structs and enums to work with conventional commits.
276
287
## License
298

0 commit comments

Comments
 (0)