diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index b4937d4..7933c71 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -11,11 +11,18 @@ jobs: clippy: name: ๐Ÿ“Ž fmt and clippy runs-on: ubuntu-latest + env: + CARGO_TERM_COLOR: always steps: - uses: actions/checkout@v4 - - run: rustup update && rustup component add clippy rustfmt + - run: | + rustup update + rustup toolchain install nightly + rustup default nightly + rustup component add clippy rustfmt - run: cargo fmt -- --check - run: cargo clippy --all --all-targets --all-features + - run: cargo bench test: name: ๐Ÿงช Tests diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3aeadb3..131b4da 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -24,11 +24,11 @@ repos: entry: cargo fmt language: system pass_filenames: false - - id: git-cliff - name: ๐Ÿ”๏ธ Update changelog - entry: git cliff -o CHANGELOG.md - language: system - pass_filenames: false + # - id: git-cliff + # name: ๐Ÿ”๏ธ Update changelog + # entry: git cliff -o CHANGELOG.md + # language: system + # pass_filenames: false ci: autofix_commit_msg: ๐ŸŽจ [pre-commit.ci] Auto format from pre-commit.com hooks autoupdate_commit_msg: โฌ† [pre-commit.ci] pre-commit autoupdate diff --git a/CHANGELOG.md b/CHANGELOG.md index a2798bc..7e80a6e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ All notable changes to this project will be documented in this file. - Add functions to find_prefixes, find_postfixes, and find_longest_prefix. Rename files - ([ccbae67](https://github.com/vemonet/ptrie/commit/ccbae673304c0d052e8625f2040b2a2005afc408)) +### ๐Ÿ“š Documentation + +- Update readme, add contributing.md, add git cliff to generate changelog, add pre-commit to automatically fmt and update changelog - ([61da9f9](https://github.com/vemonet/ptrie/commit/61da9f9456793d786ca3bb04719b27aa34f95759)) + ### ๐Ÿงช Testing - Improve tests, add GitHub actions workflows for testing and releasing, remove travis CI, update benchmark script - ([8391056](https://github.com/vemonet/ptrie/commit/839105644ff00e1ac9a8fee08bf0c5f6eb2fddf8)) diff --git a/README.md b/README.md index 8128935..cac7f4c 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ The trie is particularly effective for operations involving common prefix ident ### โœจ Find prefixes -PTrie can return all prefixes in the trie corresponding to a given string, sorted in ascending order of their length. +You can return all prefixes in the trie corresponding to a given string, sorted in ascending order of their length. ```rust use ptrie::Trie; @@ -53,7 +53,7 @@ assert_eq!(prefixes, vec!["A", "AB", "ABC"]); ### ๐Ÿ” Find postfixes -PTrie can also find all strings in the trie that begin with a specified prefix. +You can also find all strings in the trie that begin with a specified prefix. ```rust use ptrie::Trie; @@ -71,7 +71,7 @@ assert_eq!(strings, vec!["App", "Apple", "Applet"]); ### ๐Ÿ”‘ Key-based Retrieval Functions -PTrie provides functions to check for the existence of a key and to retrieve the associated value. +The crate provides functions to check for the existence of a key and to retrieve the associated value. ```rust use ptrie::Trie;