diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index cea0f1d..40502d4 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -13,13 +13,13 @@ Team member before any CI builds will run. ## Before submitting a pull request (check all applicable) -- [ ] Read the [Contributing Guide](./github/CONTRIBUTING.md) (required) -- [ ] Read the [Code Of Conduct](/CODE_OF_CONDUCT.md) (required) +- [ ] Read the [Contributing Guide](/docs/CONTRIBUTING.md) (required) +- [ ] Read the [Code Of Conduct](/docs/CODE_OF_CONDUCT.md) (required) - [ ] Include tests for your changes (if necessary) - [ ] `pre-commit run --all-files` returns no issues (required) - [ ] Update any related documentation and include any relevant screenshots -- [ ] Use [Conventional -Commits](https://www.conventionalcommits.org/en/v1.0.0/) (required) +- [ ] Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) + (required) ## Pull request type (check all applicable) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 919b804..6548925 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -107,22 +107,3 @@ jobs: - uses: Swatinem/rust-cache@v2 - name: cargo docs run: cargo doc --no-deps --document-private-items --all-features --workspace --examples - - # check-spelling: - # name: check-spelling - # needs: basics - # runs-on: ubuntu-latest - # steps: - # - name: Checkout repository - # uses: actions/checkout@v4 - # - name: Install Rust ${{ env.rust_stable }} - # uses: dtolnay/rust-toolchain@stable - # with: - # toolchain: ${{ env.rust_stable }} - # - name: Install cargo-spellcheck - # uses: taiki-e/install-action@v2 - # with: - # tool: cargo-spellcheck - # - uses: actions/checkout@v4 - # - name: cargo spellcheck - # run: cargo spellcheck --code 1 diff --git a/CHANGELOG.md b/CHANGELOG.md index dab0585..61fa798 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,8 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +and this project adheres to +[Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] @@ -11,237 +12,331 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### ⚙️ Miscellaneous Tasks -- Fix docs (#98) - ([3d2bf2f](https://github.com/andreacfromtheapp/freesound-credits/commit/3d2bf2f338150082a301cc0cd2d3bff6ab1f959f)) +- Fix docs (#98) - + ([3d2bf2f](https://github.com/andreacfromtheapp/freesound-credits/commit/3d2bf2f338150082a301cc0cd2d3bff6ab1f959f)) ## [0.2.25](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.24...v0.2.25) ### ⚙️ Miscellaneous Tasks -- Add workflows and pre-hooks and vale (#90) - ([c806e54](https://github.com/andreacfromtheapp/freesound-credits/commit/c806e54dc42fe4beed4bcc33342463a574c693fc)) +- Add workflows and pre-hooks and vale (#90) - + ([c806e54](https://github.com/andreacfromtheapp/freesound-credits/commit/c806e54dc42fe4beed4bcc33342463a574c693fc)) ## [0.2.24](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.23...v0.2.24) ### ⚙️ Miscellaneous Tasks -- Minor updates (#87) - ([6449396](https://github.com/andreacfromtheapp/freesound-credits/commit/64493962e7c89c482303eaa96e14df07f09ff425)) +- Minor updates (#87) - + ([6449396](https://github.com/andreacfromtheapp/freesound-credits/commit/64493962e7c89c482303eaa96e14df07f09ff425)) ## [0.2.22](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.21...v0.2.22) ### ⚙️ Miscellaneous Tasks -- Update Cargo.lock dependencies - ([0000000](https://github.com/andreacfromtheapp/freesound-credits/commit/0000000)) +- Update Cargo.lock dependencies - + ([0000000](https://github.com/andreacfromtheapp/freesound-credits/commit/0000000)) ## [0.2.21](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.20...v0.2.21) ### ⚙️ Miscellaneous Tasks -- Update Cargo.lock dependencies - ([0000000](https://github.com/andreacfromtheapp/freesound-credits/commit/0000000)) +- Update Cargo.lock dependencies - + ([0000000](https://github.com/andreacfromtheapp/freesound-credits/commit/0000000)) ## [0.2.20](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.19...v0.2.20) ### 🐛 Bug Fixes -- Restoring README.md for crates.io ([#74](https://github.com/andreacfromtheapp/freesound-credits/pull/74)) - ([d1fc402](https://github.com/andreacfromtheapp/freesound-credits/commit/d1fc4029cb45efb19f58b4df7acdca6a3e9ff2f6)) +- Restoring README.md for crates.io + ([#74](https://github.com/andreacfromtheapp/freesound-credits/pull/74)) - + ([d1fc402](https://github.com/andreacfromtheapp/freesound-credits/commit/d1fc4029cb45efb19f58b4df7acdca6a3e9ff2f6)) ## [0.2.19](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.18...v0.2.19) ### 🐛 Bug Fixes -- Manually updating cargo-dist ([#72](https://github.com/andreacfromtheapp/freesound-credits/pull/72)) - ([c2e1063](https://github.com/andreacfromtheapp/freesound-credits/commit/c2e1063a65267d0dd001b4dab319239853e546be)) +- Manually updating cargo-dist + ([#72](https://github.com/andreacfromtheapp/freesound-credits/pull/72)) - + ([c2e1063](https://github.com/andreacfromtheapp/freesound-credits/commit/c2e1063a65267d0dd001b4dab319239853e546be)) ### 🐛 Bug Fixes -- Trying to fix release-plz ([#70](https://github.com/andreacfromtheapp/freesound-credits/issues/70)) - ([e2662d3](https://github.com/andreacfromtheapp/freesound-credits/commit/e2662d3d60e9a4c2d4dc4edbef05e280758b11fa)) -- Restore readme md cause release-plz ([#67](https://github.com/andreacfromtheapp/freesound-credits/issues/67)) - ([6df070d](https://github.com/andreacfromtheapp/freesound-credits/commit/6df070d1d62817359929b50d1b9ac8607430d36c)) -- All links ([#65](https://github.com/andreacfromtheapp/freesound-credits/issues/65)) - ([32b3fce](https://github.com/andreacfromtheapp/freesound-credits/commit/32b3fce4eb06c055c805febe8ec1caf382e89947)) -- Update .gitignore ([#64](https://github.com/andreacfromtheapp/freesound-credits/issues/64)) - ([ed0c71c](https://github.com/andreacfromtheapp/freesound-credits/commit/ed0c71cfe77766fb7713aad201b702e547e0e9b3)) -- Update .gitignore ([#62](https://github.com/andreacfromtheapp/freesound-credits/issues/62)) - ([a85df44](https://github.com/andreacfromtheapp/freesound-credits/commit/a85df443773ff7727e6f4031f2b51425b0971b45)) +- Trying to fix release-plz + ([#70](https://github.com/andreacfromtheapp/freesound-credits/issues/70)) - + ([e2662d3](https://github.com/andreacfromtheapp/freesound-credits/commit/e2662d3d60e9a4c2d4dc4edbef05e280758b11fa)) +- Restore readme md cause release-plz + ([#67](https://github.com/andreacfromtheapp/freesound-credits/issues/67)) - + ([6df070d](https://github.com/andreacfromtheapp/freesound-credits/commit/6df070d1d62817359929b50d1b9ac8607430d36c)) +- All links + ([#65](https://github.com/andreacfromtheapp/freesound-credits/issues/65)) - + ([32b3fce](https://github.com/andreacfromtheapp/freesound-credits/commit/32b3fce4eb06c055c805febe8ec1caf382e89947)) +- Update .gitignore + ([#64](https://github.com/andreacfromtheapp/freesound-credits/issues/64)) - + ([ed0c71c](https://github.com/andreacfromtheapp/freesound-credits/commit/ed0c71cfe77766fb7713aad201b702e547e0e9b3)) +- Update .gitignore + ([#62](https://github.com/andreacfromtheapp/freesound-credits/issues/62)) - + ([a85df44](https://github.com/andreacfromtheapp/freesound-credits/commit/a85df443773ff7727e6f4031f2b51425b0971b45)) ### ⚙️ Miscellaneous Tasks -- Onemoretryatorgreadme ([#69](https://github.com/andreacfromtheapp/freesound-credits/issues/69)) - ([5d915af](https://github.com/andreacfromtheapp/freesound-credits/commit/5d915af469fb614736a725e89e2412992e023d68)) -- Move to orgmode ([#60](https://github.com/andreacfromtheapp/freesound-credits/issues/60)) - ([7e52f7f](https://github.com/andreacfromtheapp/freesound-credits/commit/7e52f7f2b43d7c49ead4ce274e65b639f0f50d3e)) +- Onemoretryatorgreadme + ([#69](https://github.com/andreacfromtheapp/freesound-credits/issues/69)) - + ([5d915af](https://github.com/andreacfromtheapp/freesound-credits/commit/5d915af469fb614736a725e89e2412992e023d68)) +- Move to orgmode + ([#60](https://github.com/andreacfromtheapp/freesound-credits/issues/60)) - + ([7e52f7f](https://github.com/andreacfromtheapp/freesound-credits/commit/7e52f7f2b43d7c49ead4ce274e65b639f0f50d3e)) ## [0.2.17](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.16..v0.2.17) ### ⚙️ Miscellaneous Tasks -- Minor fixes ([#58](https://github.com/andreacfromtheapp/freesound-credits/issues/58)) - ([533c81a](https://github.com/andreacfromtheapp/freesound-credits/commit/533c81ac7944c145c0bb060d2a9f9f9b5d7ed662)) +- Minor fixes + ([#58](https://github.com/andreacfromtheapp/freesound-credits/issues/58)) - + ([533c81a](https://github.com/andreacfromtheapp/freesound-credits/commit/533c81ac7944c145c0bb060d2a9f9f9b5d7ed662)) ## [0.2.16](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.15..v0.2.16) ### ⚙️ Miscellaneous Tasks -- Improved credit_sound + add test for non lowercase file name ([#51](https://github.com/andreacfromtheapp/freesound-credits/issues/51)) - ([afd2446](https://github.com/andreacfromtheapp/freesound-credits/commit/afd244605cfc3906f7ce9d5a83b093b07a9f28fb)) -- Add rationale codeowner + improv contrib ([#49](https://github.com/andreacfromtheapp/freesound-credits/issues/49)) - ([acd09e2](https://github.com/andreacfromtheapp/freesound-credits/commit/acd09e2b97ee07953a9b079fe2106d375722bccd)) +- Improved credit_sound + add test for non lowercase file name + ([#51](https://github.com/andreacfromtheapp/freesound-credits/issues/51)) - + ([afd2446](https://github.com/andreacfromtheapp/freesound-credits/commit/afd244605cfc3906f7ce9d5a83b093b07a9f28fb)) +- Add rationale codeowner + improv contrib + ([#49](https://github.com/andreacfromtheapp/freesound-credits/issues/49)) - + ([acd09e2](https://github.com/andreacfromtheapp/freesound-credits/commit/acd09e2b97ee07953a9b079fe2106d375722bccd)) ## [0.2.15](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.14..v0.2.15) ### ⛰️ Features -- *(spellcheck)* Add spellcheck precommit ci and config ([#39](https://github.com/andreacfromtheapp/freesound-credits/issues/39)) - ([727e79e](https://github.com/andreacfromtheapp/freesound-credits/commit/727e79edea0a0fe902fa9a5dfb63a90f5a621992)) +- _(spellcheck)_ Add spellcheck precommit ci and config + ([#39](https://github.com/andreacfromtheapp/freesound-credits/issues/39)) - + ([727e79e](https://github.com/andreacfromtheapp/freesound-credits/commit/727e79edea0a0fe902fa9a5dfb63a90f5a621992)) ### 🐛 Bug Fixes -- *(spellcheck)* +top number -precomit ([#40](https://github.com/andreacfromtheapp/freesound-credits/issues/40)) - ([139ffc9](https://github.com/andreacfromtheapp/freesound-credits/commit/139ffc90b774bb292f7030f0e07e3e472543a8d6)) -- Streamline pipelines ([#42](https://github.com/andreacfromtheapp/freesound-credits/issues/42)) - ([f8f33e8](https://github.com/andreacfromtheapp/freesound-credits/commit/f8f33e89092727cc19a844bc81f6d1a31e911570)) -- Rm redundant freesound in frontmatter ([#41](https://github.com/andreacfromtheapp/freesound-credits/issues/41)) - ([e9c24a9](https://github.com/andreacfromtheapp/freesound-credits/commit/e9c24a92a653dc41a1aab0ea3f055a101fa16249)) +- _(spellcheck)_ +top number -precomit + ([#40](https://github.com/andreacfromtheapp/freesound-credits/issues/40)) - + ([139ffc9](https://github.com/andreacfromtheapp/freesound-credits/commit/139ffc90b774bb292f7030f0e07e3e472543a8d6)) +- Streamline pipelines + ([#42](https://github.com/andreacfromtheapp/freesound-credits/issues/42)) - + ([f8f33e8](https://github.com/andreacfromtheapp/freesound-credits/commit/f8f33e89092727cc19a844bc81f6d1a31e911570)) +- Rm redundant freesound in frontmatter + ([#41](https://github.com/andreacfromtheapp/freesound-credits/issues/41)) - + ([e9c24a9](https://github.com/andreacfromtheapp/freesound-credits/commit/e9c24a92a653dc41a1aab0ea3f055a101fa16249)) ### ⚙️ Miscellaneous Tasks -- *(docs)* GitHub templates improve ([#45](https://github.com/andreacfromtheapp/freesound-credits/issues/45)) ([#47](https://github.com/andreacfromtheapp/freesound-credits/issues/47)) - ([4ddb88e](https://github.com/andreacfromtheapp/freesound-credits/commit/4ddb88eb55e537368f10b404d05e6476b01eb506)) -- *(readme)* Add licenses badges and remove written line ([#37](https://github.com/andreacfromtheapp/freesound-credits/issues/37)) - ([040b8d0](https://github.com/andreacfromtheapp/freesound-credits/commit/040b8d0c5eb87ea4ad26b66bc62154fb3b12006e)) +- _(docs)_ GitHub templates improve + ([#45](https://github.com/andreacfromtheapp/freesound-credits/issues/45)) + ([#47](https://github.com/andreacfromtheapp/freesound-credits/issues/47)) - + ([4ddb88e](https://github.com/andreacfromtheapp/freesound-credits/commit/4ddb88eb55e537368f10b404d05e6476b01eb506)) +- _(readme)_ Add licenses badges and remove written line + ([#37](https://github.com/andreacfromtheapp/freesound-credits/issues/37)) - + ([040b8d0](https://github.com/andreacfromtheapp/freesound-credits/commit/040b8d0c5eb87ea4ad26b66bc62154fb3b12006e)) ## [0.2.14](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.13..v0.2.14) ### ⛰️ Features -- *(readme)* Added commitlint badge + reoder ([#29](https://github.com/andreacfromtheapp/freesound-credits/issues/29)) - ([7da5d62](https://github.com/andreacfromtheapp/freesound-credits/commit/7da5d62f3db17c1229cd183fc7f72d3e5f3139e5)) -- *(release-plz)* Use release.link ([#35](https://github.com/andreacfromtheapp/freesound-credits/issues/35)) - ([491f627](https://github.com/andreacfromtheapp/freesound-credits/commit/491f62731568cb17814b4bbdbdb9eab50c4a1fc1)) +- _(readme)_ Added commitlint badge + reoder + ([#29](https://github.com/andreacfromtheapp/freesound-credits/issues/29)) - + ([7da5d62](https://github.com/andreacfromtheapp/freesound-credits/commit/7da5d62f3db17c1229cd183fc7f72d3e5f3139e5)) +- _(release-plz)_ Use release.link + ([#35](https://github.com/andreacfromtheapp/freesound-credits/issues/35)) - + ([491f627](https://github.com/andreacfromtheapp/freesound-credits/commit/491f62731568cb17814b4bbdbdb9eab50c4a1fc1)) ### 🐛 Bug Fixes -- *(readme)* Renamed commitlint to .yml ([#31](https://github.com/andreacfromtheapp/freesound-credits/issues/31)) - ([d5550ef](https://github.com/andreacfromtheapp/freesound-credits/commit/d5550efe38d2d943382ca9dafe2ad9fe9ce48f3b)) -- *(release-plz)* Remote.link in links was broken ([#33](https://github.com/andreacfromtheapp/freesound-credits/issues/33)) - ([ac12bc0](https://github.com/andreacfromtheapp/freesound-credits/commit/ac12bc0cf2df64df935f8f1fbd6e2a3888f22ca6)) +- _(readme)_ Renamed commitlint to .yml + ([#31](https://github.com/andreacfromtheapp/freesound-credits/issues/31)) - + ([d5550ef](https://github.com/andreacfromtheapp/freesound-credits/commit/d5550efe38d2d943382ca9dafe2ad9fe9ce48f3b)) +- _(release-plz)_ Remote.link in links was broken + ([#33](https://github.com/andreacfromtheapp/freesound-credits/issues/33)) - + ([ac12bc0](https://github.com/andreacfromtheapp/freesound-credits/commit/ac12bc0cf2df64df935f8f1fbd6e2a3888f22ca6)) ### 📚 Documentation -- *(readme)* Better wording. fix typos ([#34](https://github.com/andreacfromtheapp/freesound-credits/issues/34)) - ([93cd500](https://github.com/andreacfromtheapp/freesound-credits/commit/93cd500f8f41a378902d68cac4694162e25f2d73)) +- _(readme)_ Better wording. fix typos + ([#34](https://github.com/andreacfromtheapp/freesound-credits/issues/34)) - + ([93cd500](https://github.com/andreacfromtheapp/freesound-credits/commit/93cd500f8f41a378902d68cac4694162e25f2d73)) ### ⚙️ Miscellaneous Tasks -- Improve precommit and workflows ([#36](https://github.com/andreacfromtheapp/freesound-credits/issues/36)) - ([ff479c8](https://github.com/andreacfromtheapp/freesound-credits/commit/ff479c81d22155f6a76db4148dabd45884760072)) +- Improve precommit and workflows + ([#36](https://github.com/andreacfromtheapp/freesound-credits/issues/36)) - + ([ff479c8](https://github.com/andreacfromtheapp/freesound-credits/commit/ff479c81d22155f6a76db4148dabd45884760072)) ## [0.2.13](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.12..v0.2.13) ### 🐛 Bug Fixes -- *(release-plz)* Improvements all around ([#26](https://github.com/andreacfromtheapp/freesound-credits/issues/26)) - ([7caf55f](https://github.com/andreacfromtheapp/freesound-credits/commit/7caf55f3d681194a67cbcce13756cd4ec7c90a55)) +- _(release-plz)_ Improvements all around + ([#26](https://github.com/andreacfromtheapp/freesound-credits/issues/26)) - + ([7caf55f](https://github.com/andreacfromtheapp/freesound-credits/commit/7caf55f3d681194a67cbcce13756cd4ec7c90a55)) ### ⚙️ Miscellaneous Tasks -- *(action)* Add commitlint on push main and PRs ([#28](https://github.com/andreacfromtheapp/freesound-credits/issues/28)) - ([ea6064f](https://github.com/andreacfromtheapp/freesound-credits/commit/ea6064f4d7e9213a19e8b75ec811f586e3e949a5)) +- _(action)_ Add commitlint on push main and PRs + ([#28](https://github.com/andreacfromtheapp/freesound-credits/issues/28)) - + ([ea6064f](https://github.com/andreacfromtheapp/freesound-credits/commit/ea6064f4d7e9213a19e8b75ec811f586e3e949a5)) ## [0.2.12](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.11..v0.2.12) ### ⛰️ Features -- Adding pre-commit hook for convetional - ([924c906](https://github.com/andreacfromtheapp/freesound-credits/commit/924c906c4b662503d8e25199c44780608c323557)) +- Adding pre-commit hook for convetional - + ([924c906](https://github.com/andreacfromtheapp/freesound-credits/commit/924c906c4b662503d8e25199c44780608c323557)) ### 🐛 Bug Fixes -- *(changelog)* Better template, less redundant, fix broken links - ([d2512ae](https://github.com/andreacfromtheapp/freesound-credits/commit/d2512aeb81a63d7282f15f60fbc9bcc1f6daec60)) -- *(changelog)* New template Closes #22 - ([2e421a9](https://github.com/andreacfromtheapp/freesound-credits/commit/2e421a9db04693c5a388d05c411cac0565da7047)) -- *(pre-commit)* Don't fix. it is unsigned - ([8b544cf](https://github.com/andreacfromtheapp/freesound-credits/commit/8b544cf883c7f9b3e3bde1e61be6a086682545db)) +- _(changelog)_ Better template, less redundant, fix broken links - + ([d2512ae](https://github.com/andreacfromtheapp/freesound-credits/commit/d2512aeb81a63d7282f15f60fbc9bcc1f6daec60)) +- _(changelog)_ New template Closes #22 - + ([2e421a9](https://github.com/andreacfromtheapp/freesound-credits/commit/2e421a9db04693c5a388d05c411cac0565da7047)) +- _(pre-commit)_ Don't fix. it is unsigned - + ([8b544cf](https://github.com/andreacfromtheapp/freesound-credits/commit/8b544cf883c7f9b3e3bde1e61be6a086682545db)) ### ⚙️ Miscellaneous Tasks -- Update cargo-dist - ([b1cfa5b](https://github.com/andreacfromtheapp/freesound-credits/commit/b1cfa5b6792293e10c4e117c3449cf4847cebb43)) +- Update cargo-dist - + ([b1cfa5b](https://github.com/andreacfromtheapp/freesound-credits/commit/b1cfa5b6792293e10c4e117c3449cf4847cebb43)) ## [0.2.11](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.10..v0.2.11) ### 🐛 Bug Fixes -- Single git tag and tag template - ([aa1a051](https://github.com/andreacfromtheapp/freesound-credits/commit/aa1a051824c405c06fb4677e9786f69a106d301a)) +- Single git tag and tag template - + ([aa1a051](https://github.com/andreacfromtheapp/freesound-credits/commit/aa1a051824c405c06fb4677e9786f69a106d301a)) ### ⚙️ Miscellaneous Tasks -- Binstall name var - ([5d3977e](https://github.com/andreacfromtheapp/freesound-credits/commit/5d3977e081cda505f0998356abaee716f5e297d4)) -- Remove configs with default values - ([d5b0e9e](https://github.com/andreacfromtheapp/freesound-credits/commit/d5b0e9eb7ff69b23b0ce12ceada8010532cf8134)) +- Binstall name var - + ([5d3977e](https://github.com/andreacfromtheapp/freesound-credits/commit/5d3977e081cda505f0998356abaee716f5e297d4)) +- Remove configs with default values - + ([d5b0e9e](https://github.com/andreacfromtheapp/freesound-credits/commit/d5b0e9eb7ff69b23b0ce12ceada8010532cf8134)) ## [0.2.10](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.9..v0.2.10) ### 🐛 Bug Fixes -- Removed cliff altogether - ([4184fae](https://github.com/andreacfromtheapp/freesound-credits/commit/4184fae2bb61b4bcae32df55404ac28fbb38cf9c)) -- Trying to switch to keep a changelog - ([0c432c6](https://github.com/andreacfromtheapp/freesound-credits/commit/0c432c6557f379ba11b04484656d3e84ab803284)) +- Removed cliff altogether - + ([4184fae](https://github.com/andreacfromtheapp/freesound-credits/commit/4184fae2bb61b4bcae32df55404ac28fbb38cf9c)) +- Trying to switch to keep a changelog - + ([0c432c6](https://github.com/andreacfromtheapp/freesound-credits/commit/0c432c6557f379ba11b04484656d3e84ab803284)) ### ⚙️ Miscellaneous Tasks -- Empty the changelog - ([e675890](https://github.com/andreacfromtheapp/freesound-credits/commit/e6758909169f591c42f22007b3d6d7c2fa0cf7f6)) +- Empty the changelog - + ([e675890](https://github.com/andreacfromtheapp/freesound-credits/commit/e6758909169f591c42f22007b3d6d7c2fa0cf7f6)) ## [0.2.9](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.8..v0.2.9) ### ⚙️ Miscellaneous Tasks -- Fixing git cliff and changelog -- adding clarify for some license ([#10](https://github.com/andreacfromtheapp/freesound-credits/issues/10)) - ([fdbb853](https://github.com/andreacfromtheapp/freesound-credits/commit/fdbb853dd1c2a73f10ae5d74e909f8a10a425423)) +- Fixing git cliff and changelog -- adding clarify for some license + ([#10](https://github.com/andreacfromtheapp/freesound-credits/issues/10)) - + ([fdbb853](https://github.com/andreacfromtheapp/freesound-credits/commit/fdbb853dd1c2a73f10ae5d74e909f8a10a425423)) ## [0.2.8](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.7..v0.2.8) ### ⚙️ Miscellaneous Tasks -- Improvements for deny assist pre-commit and plz ([#8](https://github.com/andreacfromtheapp/freesound-credits/issues/8)) - ([9c9b2a2](https://github.com/andreacfromtheapp/freesound-credits/commit/9c9b2a212846aef18559dfda00550d9d901c2297)) +- Improvements for deny assist pre-commit and plz + ([#8](https://github.com/andreacfromtheapp/freesound-credits/issues/8)) - + ([9c9b2a2](https://github.com/andreacfromtheapp/freesound-credits/commit/9c9b2a212846aef18559dfda00550d9d901c2297)) ## [0.2.7](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.6..v0.2.7) ### ⚙️ Miscellaneous Tasks -- Adding emtpy chagelog file cause cargo-dist needs it. ([#6](https://github.com/andreacfromtheapp/freesound-credits/issues/6)) - ([cc0e118](https://github.com/andreacfromtheapp/freesound-credits/commit/cc0e118c1ffcf57af6d01456d6cfced3bbfbe83f)) +- Adding emtpy chagelog file cause cargo-dist needs it. + ([#6](https://github.com/andreacfromtheapp/freesound-credits/issues/6)) - + ([cc0e118](https://github.com/andreacfromtheapp/freesound-credits/commit/cc0e118c1ffcf57af6d01456d6cfced3bbfbe83f)) ## [0.2.6](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.5..v0.2.6) ### ⚙️ Miscellaneous Tasks -- Path bump for ci improvements - ([1be859a](https://github.com/andreacfromtheapp/freesound-credits/commit/1be859a751359d4114fda6002cf33409d2597448)) -- Fix cliff toml - ([f541cee](https://github.com/andreacfromtheapp/freesound-credits/commit/f541cee669415cbfab3db0c198ec83148fb92690)) -- Added cargo-assist - ([f0c0005](https://github.com/andreacfromtheapp/freesound-credits/commit/f0c0005f42ae8d853c0ba2be72b1cee787ac9e0f)) -- Change dependabot to less aggressive schedule - ([4cdcf61](https://github.com/andreacfromtheapp/freesound-credits/commit/4cdcf612e6a11f66f5ec29981f92aa7027f387cb)) +- Path bump for ci improvements - + ([1be859a](https://github.com/andreacfromtheapp/freesound-credits/commit/1be859a751359d4114fda6002cf33409d2597448)) +- Fix cliff toml - + ([f541cee](https://github.com/andreacfromtheapp/freesound-credits/commit/f541cee669415cbfab3db0c198ec83148fb92690)) +- Added cargo-assist - + ([f0c0005](https://github.com/andreacfromtheapp/freesound-credits/commit/f0c0005f42ae8d853c0ba2be72b1cee787ac9e0f)) +- Change dependabot to less aggressive schedule - + ([4cdcf61](https://github.com/andreacfromtheapp/freesound-credits/commit/4cdcf612e6a11f66f5ec29981f92aa7027f387cb)) ## [0.2.5](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.4..v0.2.5) ### ⛰️ Features -- Added musl - ([f30644d](https://github.com/andreacfromtheapp/freesound-credits/commit/f30644d070dd8b9472905b8da1c1b4d10283bb7c)) -- Added homebrew - ([d10839f](https://github.com/andreacfromtheapp/freesound-credits/commit/d10839fe941eff7348926c2ac962b1da4f406410)) +- Added musl - + ([f30644d](https://github.com/andreacfromtheapp/freesound-credits/commit/f30644d070dd8b9472905b8da1c1b4d10283bb7c)) +- Added homebrew - + ([d10839f](https://github.com/andreacfromtheapp/freesound-credits/commit/d10839fe941eff7348926c2ac962b1da4f406410)) ### 🐛 Bug Fixes -- Change run mode to upload - ([22d288c](https://github.com/andreacfromtheapp/freesound-credits/commit/22d288c0fc6c4d74a8a83ef09f0b72b3642d2be7)) +- Change run mode to upload - + ([22d288c](https://github.com/andreacfromtheapp/freesound-credits/commit/22d288c0fc6c4d74a8a83ef09f0b72b3642d2be7)) ### ⚙️ Miscellaneous Tasks -- Chronological order for badges - ([f1a4f68](https://github.com/andreacfromtheapp/freesound-credits/commit/f1a4f68a2939cb6da3d581640f4739c88f559095)) +- Chronological order for badges - + ([f1a4f68](https://github.com/andreacfromtheapp/freesound-credits/commit/f1a4f68a2939cb6da3d581640f4739c88f559095)) ## [0.2.4](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.3..v0.2.4) ### ⚙️ Miscellaneous Tasks -- Bump version to be on track with release-plz and crates - ([667af7f](https://github.com/andreacfromtheapp/freesound-credits/commit/667af7f8979586f19653e6f69f142a9e0f174b33)) -- Fix badge name for deployment - ([ca31d63](https://github.com/andreacfromtheapp/freesound-credits/commit/ca31d6337ac6812f16661c0bbd64e87b244d717b)) +- Bump version to be on track with release-plz and crates - + ([667af7f](https://github.com/andreacfromtheapp/freesound-credits/commit/667af7f8979586f19653e6f69f142a9e0f174b33)) +- Fix badge name for deployment - + ([ca31d63](https://github.com/andreacfromtheapp/freesound-credits/commit/ca31d6337ac6812f16661c0bbd64e87b244d717b)) ## [0.2.3](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.2..v0.2.3) ### ⚙️ Miscellaneous Tasks -- Automated CI/CD improved - ([4c93d95](https://github.com/andreacfromtheapp/freesound-credits/commit/4c93d9528189655a75d18b72d9192cbc67526a45)) -- Add/fix templates emojis - ([2dbe1d7](https://github.com/andreacfromtheapp/freesound-credits/commit/2dbe1d746a34399b8d405568ea7391c781ed344c)) -- Delete leftover script dir - ([dedf877](https://github.com/andreacfromtheapp/freesound-credits/commit/dedf8777f5f8a5209bd8b7ccb5c4b0a59d126304)) +- Automated CI/CD improved - + ([4c93d95](https://github.com/andreacfromtheapp/freesound-credits/commit/4c93d9528189655a75d18b72d9192cbc67526a45)) +- Add/fix templates emojis - + ([2dbe1d7](https://github.com/andreacfromtheapp/freesound-credits/commit/2dbe1d746a34399b8d405568ea7391c781ed344c)) +- Delete leftover script dir - + ([dedf877](https://github.com/andreacfromtheapp/freesound-credits/commit/dedf8777f5f8a5209bd8b7ccb5c4b0a59d126304)) ## [0.2.2](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.1..v0.2.2) ### ⚙️ Miscellaneous Tasks -- Wow shiny new cargo-dist CI! - ([8c76d66](https://github.com/andreacfromtheapp/freesound-credits/commit/8c76d6682c05a8bd5200abb6d71d68941b19ec99)) +- Wow shiny new cargo-dist CI! - + ([8c76d66](https://github.com/andreacfromtheapp/freesound-credits/commit/8c76d6682c05a8bd5200abb6d71d68941b19ec99)) ## [0.2.1](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.2.0..v0.2.1) ### 🐛 Bug Fixes -- *(rewadme)* Cargo version bump to fix install mistake - ([c8ef775](https://github.com/andreacfromtheapp/freesound-credits/commit/c8ef775ea3527920b2df8c9a78eb37421e76c421)) +- _(rewadme)_ Cargo version bump to fix install mistake - + ([c8ef775](https://github.com/andreacfromtheapp/freesound-credits/commit/c8ef775ea3527920b2df8c9a78eb37421e76c421)) ## [0.2.0](https://github.com/andreacfromtheapp/freesound-credits/compare/v0.1.2..v0.2.0) ### ⛰️ Features -- *(issue)* Add feature request template - ([d10b225](https://github.com/andreacfromtheapp/freesound-credits/commit/d10b225da2e5d2e287cf546c34e0b1cb7ad7d555)) -- *(issue)* Add bug report template - ([52ce50d](https://github.com/andreacfromtheapp/freesound-credits/commit/52ce50d795dd765805a7b8683901b2b6f3ab89f7)) -- *(issue)* Adding DAW request template - ([05c5a36](https://github.com/andreacfromtheapp/freesound-credits/commit/05c5a36eec0cfb98146e04d367679b57ae9c7910)) +- _(issue)_ Add feature request template - + ([d10b225](https://github.com/andreacfromtheapp/freesound-credits/commit/d10b225da2e5d2e287cf546c34e0b1cb7ad7d555)) +- _(issue)_ Add bug report template - + ([52ce50d](https://github.com/andreacfromtheapp/freesound-credits/commit/52ce50d795dd765805a7b8683901b2b6f3ab89f7)) +- _(issue)_ Adding DAW request template - + ([05c5a36](https://github.com/andreacfromtheapp/freesound-credits/commit/05c5a36eec0cfb98146e04d367679b57ae9c7910)) ### 🐛 Bug Fixes -- *(readme)* Added cc section and link to contribute - ([15145ee](https://github.com/andreacfromtheapp/freesound-credits/commit/15145ee337c1d63e70a28add8caa7fbbb1ecac29)) +- _(readme)_ Added cc section and link to contribute - + ([15145ee](https://github.com/andreacfromtheapp/freesound-credits/commit/15145ee337c1d63e70a28add8caa7fbbb1ecac29)) ### 📚 Documentation -- *(contributing)* Adding contributing - ([f60b2e6](https://github.com/andreacfromtheapp/freesound-credits/commit/f60b2e64844de98f61eea81a4967a4a06846baba)) - +- _(contributing)_ Adding contributing - + ([f60b2e6](https://github.com/andreacfromtheapp/freesound-credits/commit/f60b2e64844de98f61eea81a4967a4a06846baba)) diff --git a/Cargo.lock b/Cargo.lock index f4661b7..78c6eb9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -119,9 +119,9 @@ checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf" [[package]] name = "once_cell" -version = "1.20.2" +version = "1.20.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1261fe7e33c73b354eab43b1273a57c8f967d0391e80353e51f764ac02cf6775" +checksum = "945462a4b81e43c4e3ba96bd7b49d834c6f61198356aa858733bc4acf3cbe62e" [[package]] name = "proc-macro2" @@ -149,9 +149,9 @@ checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" [[package]] name = "syn" -version = "2.0.96" +version = "2.0.98" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d5d0adab1ae378d7f53bdebc67a39f1f151407ef230f0ce2883572f5d8985c80" +checksum = "36147f1a48ae0ec2b5b3bc5b537d267457555a10dc06f3dbc8cb11ba3006d3b1" dependencies = [ "proc-macro2", "quote", @@ -160,9 +160,9 @@ dependencies = [ [[package]] name = "unicode-ident" -version = "1.0.15" +version = "1.0.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "11cd88e12b17c6494200a9c1b683a04fcac9573ed74cd1b62aeb2727c5592243" +checksum = "a210d160f08b701c8721ba1c726c11662f877ea6b7094007e1ca9a1041945034" [[package]] name = "utf8parse" diff --git a/Cargo.toml b/Cargo.toml index 59578ac..3d9fe9a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -19,7 +19,7 @@ name = "freesound-credits" path = "src/main.rs" [dependencies] -clap = { version = "4.5.23", features = ["derive"] } +clap = { version = "4.5.30", features = ["derive"] } # Config for 'cargo dist' [profile.release] diff --git a/README.md b/README.md index 8ff6a38..bb18fdf 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,13 @@ MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/ Giving credits in the [Creative Commons](https://creativecommons.org) community is often the sole requirement to freely use samples in your own creations. This -tool helps you abide to [Copyleft](https://en.wikipedia.org/wiki/Copyleft) -and credit the generous artists that contribute sounds on +tool helps you abide to [Copyleft](https://en.wikipedia.org/wiki/Copyleft) and +credit the generous artists that contribute sounds on [Freesound](https://freesound.org), helping you being more creative. -Until today, giving credits may have been a process that you begrudged. This -may have been stopping you from giving credits altogether. Not because you -didn't want to, but because it was cumbersome and tedious. +Until today, giving credits may have been a process that you begrudged. This may +have been stopping you from giving credits altogether. Not because you didn't +want to, but because it was cumbersome and tedious. Not anymore! Thanks to `freesound-credits` it takes seconds now! @@ -80,9 +80,9 @@ kept their original samples names per downloads from the platform. For example: ## Supported DAWs `freesound-credits` should work for any samples stored in a flat folder. -`freesound-credits` filters out metadata files associated with audio imports. -To add more DAWs and associated metadata or extraction, please [file an -issue](https://github.com/andreacfromtheapp/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+). +`freesound-credits` filters out metadata files associated with audio imports. To +add more DAWs and associated metadata or extraction, please +[file an issue](https://github.com/andreacfromtheapp/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+). | DAW | Samples Folder | Metadata | Extraction | Notes | | :---------: | :----------------: | :---------: | :--------: | :--------------------------------------------------------------: | @@ -98,11 +98,11 @@ and Renoise projects on macOS. Logic Pro X uses no metadata and a clean Audio files folder, thus I decided to add it but it hasn't been tested. However, any DAW with these characteristics should work out of the box. I would -appreciate anybody confirming more DAWs or [adding new -ones](https://github.com/andreacfromtheapp/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+). -When you do request or add a new DAW, please keep the [above -table](#supported-daws) and the [extra steps](#extra-daws-steps) section in -mind for any extra information. +appreciate anybody confirming more DAWs or +[adding new ones](https://github.com/andreacfromtheapp/freesound-credits/issues/new?assignees=&labels=enhancement&projects=&template=add_a_new_daw.yml&title=feat%28DAW%29%3A+add+). +When you do request or add a new DAW, please keep the +[above table](#supported-daws) and the [extra steps](#extra-daws-steps) section +in mind for any extra information. ## Extra DAWs steps @@ -114,5 +114,5 @@ Extract with `unzip your_project.xrns` first. Once unzipped, you will find a ## Contributing Thanks for your help improving the project! :balloon: Happy to have you! Peruse -the [contributing guide](./docs/CONTRIBUTING.org) to help you get involved in -the project. +the [contributing guide](./docs/CONTRIBUTING.md) to help you get involved in the +project. diff --git a/TODO.md b/TODO.md index 4877845..d49a64e 100644 --- a/TODO.md +++ b/TODO.md @@ -1,8 +1,8 @@ # TODO -- add test for `get_list_of_samples`{.verbatim} in `lib.rs`{.verbatim} -- add support for Zola front-matter template - - given a `zolafm-template.toml`{.verbatim} - - read/parse file - - use it with `set_frontmatter`{.verbatim} - - if no template -\> defaults to current hard-coded one +- add test for `get_list_of_samples`{.verbatim} in `lib.rs`{.verbatim} +- add support for Zola front-matter template + - given a `zolafm-template.toml`{.verbatim} + - read/parse file + - use it with `set_frontmatter`{.verbatim} + - if no template -\> defaults to current hard-coded one diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index 203e526..ae279b4 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -1,4 +1,4 @@ # The Rust Code of Conduct -The Code of Conduct for this repository [can be found -online](https://www.rust-lang.org/conduct.html). +The Code of Conduct for this repository +[can be found online](https://www.rust-lang.org/conduct.html). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c7b09ba..438e1ca 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -3,139 +3,120 @@ Thank you for investing your time in contributing to this project! **Contributions of all sizes welcome and valued here.** :pray: -In this guide you will get an overview of the contribution workflow from -opening an issue, creating a PR, reviewing, and merging the PR. +In this guide you will get an overview of the contribution workflow from opening +an issue, creating a PR, reviewing, and merging the PR. ## Rationale -For an overview of the project\'s MSRV, best practices, tooling, -automation, and more, make sure to read the -[Rationale](docs/RATIONALE.org). +For an overview of the project\'s MSRV, best practices, tooling, automation, and +more, make sure to read the [Rationale](docs/RATIONALE.md). ## Conduct -This project adheres to the [Code of Conduct](docs/CODE_OF_CONDUCT.org). -This describes the _minimal_ behavior expected from all contributors. - -## OrgMode - -To understand why this project adopts OrgMode as much as possible and -how to add support for it in your editor, please refer to -[Rationale](docs/RATIONALE.org). +This project adheres to the [Code of Conduct](docs/CODE_OF_CONDUCT.md). This +describes the _minimal_ behavior expected from all contributors. ## New contributor guide Some resources to help you get started with open source contributions: -- [Finding ways to contribute to open source on - GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) -- [Set up - Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) -- [Collaborating with pull - requests](https://docs.github.com/en/github/collaborating-with-pull-requests) +- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) +- [Set up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) ## Contributing in issues For any issue, the three fundamental ways an individual can contribute: -1. By opening the issue for discussion: For instance, if you believe - that you have discovered a bug. +1. By opening the issue for discussion: For instance, if you believe that you + have discovered a bug. -2. By helping to triage the issue: Providing supporting details (a test - case that demonstrates a bug), providing suggestions on how to deal - with the issue, or ensuring that the issue has appropriate tags. +2. By helping to triage the issue: Providing supporting details (a test case + that demonstrates a bug), providing suggestions on how to deal with the + issue, or ensuring that the issue has appropriate tags. 3. By helping to resolve the issue: Typically either in the form of - demonstrating that the issue reported ain\'t a problem after all, or - more often, by opening a Pull Request that changes some bit of - something in a concrete and reviewable manner. + demonstrating that the issue reported ain\'t a problem after all, or more + often, by opening a Pull Request that changes some bit of something in a + concrete and reviewable manner. -**Anybody can partake in any stage of contribution**. This project -encourages you to partake in the discussion around bugs and partake in -reviewing pull requests. +**Anybody can partake in any stage of contribution**. This project encourages +you to partake in the discussion around bugs and partake in reviewing pull +requests. ### Asking for general help If you have reviewed existing documentation and still have questions or -problems, you can [open a -discussion](https://github.com/andreacfromtheapp/freesound-credits/discussions/new) +problems, you can +[open a discussion](https://github.com/andreacfromtheapp/freesound-credits/discussions/new) asking for help. -In exchange for receiving help, this project asks that you contribute -back a documentation PR that helps others avoid the problems that you -encountered. +In exchange for receiving help, this project asks that you contribute back a +documentation PR that helps others avoid the problems that you encountered. ### Submitting a bug report -If you spot a problem, [search if an issue already -exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). -If a related issue doesn\'t exist, you can open a new issue using a -relevant [issue -form](https://github.com/andreacfromtheapp/freesound-credits/issues/new/choose). -Please fill out this form, following the template to the best of your -ability. +If you spot a problem, +[search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). +If a related issue doesn\'t exist, you can open a new issue using a relevant +[issue form](https://github.com/andreacfromtheapp/freesound-credits/issues/new/choose). +Please fill out this form, following the template to the best of your ability. -The two most important pieces of information: a description of the -behavior you see and a test case to recreate the problem. See [How to -create a Minimal, Complete, and Verifiable -example](https://stackoverflow.com/help/mcve). +The two most important pieces of information: a description of the behavior you +see and a test case to recreate the problem. See +[How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve). ### Triaging a bug report Common practice includes having a discussion around open issues. Some -contributors may have differing opinions about the issue, including -whether the behavior constitute a bug or a feature. This discussion -should stay focused, helpful, and professional. - -Short, clipped responses that give neither added context nor supporting -detail ain\'t helpful nor professional. To most, such responses seem -annoying and unfriendly. - -This project encourages contributors to help one another make forward -progress as much as possible. Empowering one another to solve issues -collaboratively. Wether you feel either doesn\'t qualify as a problem, -or if you happen upon information that you feel incongruous. When -commenting on an issue, explain why you feel that way. With supporting -context. Willing to concede misconstruing. By doing so, often leads the -correct outcome much faster. +contributors may have differing opinions about the issue, including whether the +behavior constitute a bug or a feature. This discussion should stay focused, +helpful, and professional. + +Short, clipped responses that give neither added context nor supporting detail +ain\'t helpful nor professional. To most, such responses seem annoying and +unfriendly. + +This project encourages contributors to help one another make forward progress +as much as possible. Empowering one another to solve issues collaboratively. +Wether you feel either doesn\'t qualify as a problem, or if you happen upon +information that you feel incongruous. When commenting on an issue, explain why +you feel that way. With supporting context. Willing to concede misconstruing. By +doing so, often leads the correct outcome much faster. ### Resolving a bug report -In the majority of cases, resolving issues involve opening a Pull -Request. The process for opening and reviewing a Pull Request resembles -that of opening and triage issues. Although it carries with it a -necessary review and approval workflow that ensures that the proposed -changes meet the minimal quality and functional guidelines of the -project. +In the majority of cases, resolving issues involve opening a Pull Request. The +process for opening and reviewing a Pull Request resembles that of opening and +triage issues. Although it carries with it a necessary review and approval +workflow that ensures that the proposed changes meet the minimal quality and +functional guidelines of the project. ## Making changes -To learn more about local tooling requirements and why this project -relies on them, read more about it -[here](docs/RATIONALE.md#local-tooling). +To learn more about local tooling requirements and why this project relies on +them, read more about it [here](docs/RATIONALE.md#local-tooling). ### Installing requirements -> \[!IMPORTANT\] Contributors necessarily need installing and perusing -> tooling locally guaranteeing contracts before committing any changes. +> \[!IMPORTANT\] Contributors necessarily need installing and perusing tooling +> locally guaranteeing contracts before committing any changes. -- If necessary, [set up Rust](https://www.rust-lang.org/tools/install) - with `rustup`{.verbatim}: `curl --proto '=https' --tlsv1.2 -sSf - https://sh.rustup.rs | sh`{.verbatim} +- If necessary, [set up Rust](https://www.rust-lang.org/tools/install) with + `rustup`{.verbatim}: + `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`{.verbatim} - Install [`cargo auditable`{.verbatim}](https://github.com/rust-secure-code/cargo-auditable): `cargo install cargo-auditable --locked`{.verbatim} - - Set up a [shell alias for - `cargo auditable`{.verbatim}](https://github.com/rust-secure-code/cargo-auditable?tab=readme-ov-file#can-i-make-cargo-always-build-with-cargo-auditable) + - Set up a + [shell alias for `cargo auditable`{.verbatim}](https://github.com/rust-secure-code/cargo-auditable?tab=readme-ov-file#can-i-make-cargo-always-build-with-cargo-auditable) - Install [`cargo deny`{.verbatim}](https://embarkstudios.github.io/cargo-deny/): `cargo install cargo-deny --locked`{.verbatim} -- Install - [`trufflehog`{.verbatim}](https://trufflesecurity.com/trufflehog): +- Install [`trufflehog`{.verbatim}](https://trufflesecurity.com/trufflehog): `brew install trufflehog`{.verbatim} - - Otherwise, download a binary from [`trufflehog`{.verbatim} - release - page](https://github.com/trufflesecurity/trufflehog/releases). + - Otherwise, download a binary from + [`trufflehog`{.verbatim} release page](https://github.com/trufflesecurity/trufflehog/releases). - Install [`pre-commit`{.verbatim}](https://pre-commit.com): `pip install pre-commit`{.verbatim} @@ -145,18 +126,16 @@ relies on them, read more about it - Using GitHub Desktop: - - [Getting started with GitHub - Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) + - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. - - Once you set up Desktop, you can use it to [fork the - repository](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! + - Once you set up Desktop, you can use it to + [fork the repository](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! - Using the command line: - - [Fork the - repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) - so that you can make your changes without affecting the original - project until you\'re ready to merge them. + - [Fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) + so that you can make your changes without affecting the original project + until you\'re ready to merge them. - 2 Change into the cloned repository: `cd github`{.verbatim}. @@ -167,35 +146,33 @@ relies on them, read more about it ## Pull requests -Pull Requests: the concrete way to apply changes to the code, -documentation, and dependencies in the repository. +Pull Requests: the concrete way to apply changes to the code, documentation, and +dependencies in the repository. -Even tiny pull requests (e.g: one character pull request fixing a typo -in API documentation) highly appreciated. Before making a large change, -first open an issue describing the change to seek feedback and guidance. -This will increase the likelihood of the PR getting merged. +Even tiny pull requests (e.g: one character pull request fixing a typo in API +documentation) highly appreciated. Before making a large change, first open an +issue describing the change to seek feedback and guidance. This will increase +the likelihood of the PR getting merged. -When you completed the changes, create a pull request, also known as a -PR. +When you completed the changes, create a pull request, also known as a PR. -- Don\'t forget to [link PR to - issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue), +- Don\'t forget to + [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue), should you solve one. -- Enable the checkbox to [allow maintainer - edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) - . Once you submit your PR, a team member will review your proposal. - The team may ask questions or request farther information. -- The team may ask for farther changes before merging a PR, either - using [suggested - changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) - or pull request comments. You can apply suggested changes directly - through the UI. You can make any other changes in your fork, then - commit them to your branch. +- Enable the checkbox to + [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) + . Once you submit your PR, a team member will review your proposal. The team + may ask questions or request farther information. +- The team may ask for farther changes before merging a PR, either using + [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) + or pull request comments. You can apply suggested changes directly through the + UI. You can make any other changes in your fork, then commit them to your + branch. - As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). -- If you run into any merge issues, checkout this [git - tutorial](https://github.com/skills/resolve-merge-conflicts) to help - you resolve merge conflicts and other issues. +- If you run into any merge issues, checkout this + [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you + resolve merge conflicts and other issues. ### Performing pre-commit checks on the codebase @@ -205,110 +182,103 @@ Before committing any changes, make sure to run: pre-commit run --all-files ``` -**Should it present any warning or issue: please fix, rinse, and -repeat.** +**Should it present any warning or issue: please fix, rinse, and repeat.** ### Testing -If the proposed change alters code, either adding new functionality to -the project or fixing existing, broken functionality: include tests to -guarantee that the project has no regressions in the future. +If the proposed change alters code, either adding new functionality to the +project or fixing existing, broken functionality: include tests to guarantee +that the project has no regressions in the future. -You can achieve this with three ways to write tests: unit tests, -integration tests, and documentation tests. +You can achieve this with three ways to write tests: unit tests, integration +tests, and documentation tests. 1. Unit tests - [Unit - tests](https://doc.rust-lang.org/book/ch11-03-test-organization.html#unit-tests) - go in the same source code file as the data structures and - procedures they\'re testing. To run all tests or a subset of tests, - refer [to The - Book](https://doc.rust-lang.org/book/ch11-02-running-tests.html). + [Unit tests](https://doc.rust-lang.org/book/ch11-03-test-organization.html#unit-tests) + go in the same source code file as the data structures and procedures + they\'re testing. To run all tests or a subset of tests, refer + [to The Book](https://doc.rust-lang.org/book/ch11-02-running-tests.html). > \[!IMPORTANT\] Write tests that fail for code that one shouldn\'t > implement, to avoid future regressions and unwanted behaviors. 2. Integration tests - Typically, [integration - tests](https://doc.rust-lang.org/book/ch11-03-test-organization.html#integration-tests) - go in the same crate as the code they test. That said, this project - sole possible integration test is to run - `freesound-credits`{.verbatim} against a DAW sample folder. Make - sure to check this always works when making meaningful changes. + Typically, + [integration tests](https://doc.rust-lang.org/book/ch11-03-test-organization.html#integration-tests) + go in the same crate as the code they test. That said, this project sole + possible integration test is to run `freesound-credits`{.verbatim} against a + DAW sample folder. Make sure to check this always works when making + meaningful changes. 3. Documentation tests - Ideally, every API has at least one [documentation - test](https://doc.rust-lang.org/rustdoc/documentation-tests.html) + Ideally, every API has at least one + [documentation test](https://doc.rust-lang.org/rustdoc/documentation-tests.html) that demonstrates how to use the API. - Documentation tests run with `cargo test --doc`{.verbatim}. This - ensures that the example congruously carries out and provides test - coverage. + Documentation tests run with `cargo test --doc`{.verbatim}. This ensures + that the example congruously carries out and provides test coverage. - When writing documentation tests strike a balance between brevity - for a reader to understand and code actually testing the API. + When writing documentation tests strike a balance between brevity for a + reader to understand and code actually testing the API. - Same as with integration tests, when writing a documentation test, - full access to the crate is available. Notably useful for getting - access to the runtime to run the example. + Same as with integration tests, when writing a documentation test, full + access to the crate is available. Notably useful for getting access to the + runtime to run the example. - The documentation tests visibility spans from both the crate - specific documentation **and** the project facade documentation via - the re-export. Write examples from the point of view of a user using - the crate. As such, the example should use the API via the facade - and not by directly referencing the crate. + The documentation tests visibility spans from both the crate specific + documentation **and** the project facade documentation via the re-export. + Write examples from the point of view of a user using the crate. As such, + the example should use the API via the facade and not by directly + referencing the crate. ### Committing updates -Best practice recommend to keep your changes as logically grouped as -possible within individual commits. The project imposes no limit to the -number of commits any single Pull Request may have. Most contributors -find it easier to review changes split across several commits. +Best practice recommend to keep your changes as logically grouped as possible +within individual commits. The project imposes no limit to the number of commits +any single Pull Request may have. Most contributors find it easier to review +changes split across several commits. -That said, if you have several \"checkpoints\" commits that don\'t -represent a single logical change, please squash those together. +That said, if you have several \"checkpoints\" commits that don\'t represent a +single logical change, please squash those together. -> \[!NOTE\] Several commits often get squashed during merges nonetheless -> See: the notes about [commit squashing](#commit-squashing). +> \[!NOTE\] Several commits often get squashed during merges nonetheless See: +> the notes about [commit squashing](#commit-squashing). 1. Commit message guidelines - Make sure to use [Conventional - Commits](https://www.conventionalcommits.org/en/v1.0.0/#why-use-conventional-commits). + Make sure to use + [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#why-use-conventional-commits). A good commit message should describe what changed and why. - 1 The first line should: - - contain a short description of the change (preferably 50 - characters or less, and no more than 72 characters) + - contain a short description of the change (preferably 50 characters or + less, and no more than 72 characters) - - composed entirely of lowercase except for proper nouns, - acronyms, and the words that refer to code, like - function/variable names + - composed entirely of lowercase except for proper nouns, acronyms, and + the words that refer to code, like function/variable names - start with an imperative verb - not have a full stop at the end - - prefixed with the name of the changed module; the same as - the M-\* label on the PR + - prefixed with the name of the changed module; the same as the M-\* label + on the PR Examples: - - time: introduce `Timeout`{.verbatim} and deprecate - `Deadline`{.verbatim} + - time: introduce `Timeout`{.verbatim} and deprecate `Deadline`{.verbatim} - ci: fix the FreeBSD ci configuration - 2 Keep the second line blank. - 3 Wrap all other lines at 72 columns (except for long URLs). - - 4 If your patch fixes an open issue, you can add a reference to - it at the end of the log. Use the `Fixes: #`{.verbatim} prefix - and the issue number. For other references use - `Refs: #`{.verbatim}. `Refs`{.verbatim} may include issues, - separated by a comma. + - 4 If your patch fixes an open issue, you can add a reference to it at the + end of the log. Use the `Fixes: #`{.verbatim} prefix and the issue number. + For other references use `Refs: #`{.verbatim}. `Refs`{.verbatim} may + include issues, separated by a comma. Examples: @@ -333,120 +303,110 @@ represent a single logical change, please squash those together. ### Opening the pull request From within GitHub, opening a new Pull Request will present you with a -[template](.github/PULL_REQUEST_TEMPLATE/pull_request_template.md). -Please try to do your best at filling out the details, but feel free to -skip parts if ain\'t sure what to put. +[template](.github/PULL_REQUEST_TEMPLATE/pull_request_template.md). Please try +to do your best at filling out the details, but feel free to skip parts if +ain\'t sure what to put. ### Discuss and update -You will probably get feedback or requests for changes to your Pull -Request. Commonly, a big part of the submission process. Don\'t -discourage! Some contributors may sign off on the Pull Request right -away, others may have more detailed comments or feedback. This is a -necessary part of the process in order to appraise whether the changes -subsist correct and necessary. +You will probably get feedback or requests for changes to your Pull Request. +Commonly, a big part of the submission process. Don\'t discourage! Some +contributors may sign off on the Pull Request right away, others may have more +detailed comments or feedback. This is a necessary part of the process in order +to appraise whether the changes subsist correct and necessary. -**Any community member can review a PR and you might get conflicting -feedback**. Keep an eye out for comments from code owners to provide -guidance on conflicting feedback. +**Any community member can review a PR and you might get conflicting feedback**. +Keep an eye out for comments from code owners to provide guidance on conflicting +feedback. -**Once the PR is open, don\'t rebase the commits**. See [Commit -Squashing](#commit-squashing) for more details. +**Once the PR is open, don\'t rebase the commits**. See +[Commit Squashing](#commit-squashing) for more details. ### Commit squashing -**Don\'t squash commits that you add to your Pull Request during the -review process**. +**Don\'t squash commits that you add to your Pull Request during the review +process**. -When the commits in your Pull Request land, they may be squashed into -one commit per logical change. Metadata will be added to the commit -message (including links to the Pull Request, links to relevant issues, -and the names of the reviewers). The commit history of your Pull -Request. Nonetheless, will stay intact on the Pull Request page. +When the commits in your Pull Request land, they may be squashed into one commit +per logical change. Metadata will be added to the commit message (including +links to the Pull Request, links to relevant issues, and the names of the +reviewers). The commit history of your Pull Request. Nonetheless, will stay +intact on the Pull Request page. ## Reviewing pull requests **Any community member welcome to review any pull request**. -All contributors who choose to review and give feedback on Pull Requests -have a responsibility to both the project and the individual making the -contribution. Reviews and feedback must be helpful, insightful, and -geared towards improving the contribution as opposed to blocking it. -Should you have reasons why you feel the PR shouldn\'t land, explain -what those are. Don\'t expect to be able to block a Pull Request from -advancing just because you say \"No\" without giving an explanation. -Stay open to having your mind changed. Stay open to working with the -contributor to make the Pull Request better. - -Dismissive or disrespectful reviews of the contributor or any other -reviewers disincline with the [Code of -Conduct](docs/CODE_OF_CONDUCT.md). - -When reviewing a Pull Request, the primary goals consist of for the -codebase to improve and for the person submitting the request to -succeed. \*Even if a Pull Request doesn\'t land, the submitters should -come away from the experience feeling like their effort wasn\'t wasted -or unappreciated\*. Treat every Pull Request from a new contributor as -an opportunity to grow the community. +All contributors who choose to review and give feedback on Pull Requests have a +responsibility to both the project and the individual making the contribution. +Reviews and feedback must be helpful, insightful, and geared towards improving +the contribution as opposed to blocking it. Should you have reasons why you feel +the PR shouldn\'t land, explain what those are. Don\'t expect to be able to +block a Pull Request from advancing just because you say \"No\" without giving +an explanation. Stay open to having your mind changed. Stay open to working with +the contributor to make the Pull Request better. + +Dismissive or disrespectful reviews of the contributor or any other reviewers +disincline with the [Code of Conduct](docs/CODE_OF_CONDUCT.md). + +When reviewing a Pull Request, the primary goals consist of for the codebase to +improve and for the person submitting the request to succeed. \*Even if a Pull +Request doesn\'t land, the submitters should come away from the experience +feeling like their effort wasn\'t wasted or unappreciated\*. Treat every Pull +Request from a new contributor as an opportunity to grow the community. ### Review a bit at a time **Avoid overwhelming new contributors**. -As tempting as micro-optimizing and make everything about relative -performance, perfect grammar, or exact style matches, may be: don\'t -succumb to that temptation. +As tempting as micro-optimizing and make everything about relative performance, +perfect grammar, or exact style matches, may be: don\'t succumb to that +temptation. Focus first on the most significant aspects of the change: 1. Does this change make sense for the project? -2. Does this change make the project better, even if only - incrementally? +2. Does this change make the project better, even if only incrementally? 3. Are there clear bugs or larger scale issues that need attending to? -4. Is the commit message readable and correct? If it has a breaking - change is it clear enough? +4. Is the commit message readable and correct? If it has a breaking change is + it clear enough? -Note that **incremental** improvement suffices to land a PR. This means -that the PR doesn\'t need to meet perfection. _Better than the status -quo_ qualifies. One can open follow up Pull Requests to continue -iterating. +Note that **incremental** improvement suffices to land a PR. This means that the +PR doesn\'t need to meet perfection. _Better than the status quo_ qualifies. One +can open follow up Pull Requests to continue iterating. -When changes prove necessary, _request_ them, don\'t _demand_ them, and -**don\'t assume that the submitter already knows how to add a test or -run a benchmark**. +When changes prove necessary, _request_ them, don\'t _demand_ them, and **don\'t +assume that the submitter already knows how to add a test or run a benchmark**. -Specific performance optimization techniques, coding styles and -conventions change over time. The first impression you give to a new -contributor never does. +Specific performance optimization techniques, coding styles and conventions +change over time. The first impression you give to a new contributor never does. -Nits (non-essential requests for small changes) accepted, but try to -avoid stalling the Pull Request. While the Team Collaborator landing the -Pull Request can typically fix most nits, also consider them an -opportunity for the contributor to learn a bit more about the project. +Nits (non-essential requests for small changes) accepted, but try to avoid +stalling the Pull Request. While the Team Collaborator landing the Pull Request +can typically fix most nits, also consider them an opportunity for the +contributor to learn a bit more about the project. -> \[!NOTE\] Always denote nits when you comment: e.g. =nit: change foo() -> to bar(). But this is not blocking.= +> \[!NOTE\] Always denote nits when you comment: e.g. =nit: change foo() to +> bar(). But this is not blocking.= -If addressed comments ain\'t folded automatically after new commits or -if they proved mistaken, please, [hide -them](https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment) -with the appropriate reason to keep the conversation flow concise and -relevant. +If addressed comments ain\'t folded automatically after new commits or if they +proved mistaken, please, +[hide them](https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment) +with the appropriate reason to keep the conversation flow concise and relevant. ### The person behind the code -Be aware that _how_ you communicate requests and reviews in your -feedback can have a significant impact on the success of the Pull -Request. Yes, landing a particular change may improve the project, but -the individual might just not want to have anything to do with the -project ever again. Having good code ain\'t the sole goal. +Be aware that _how_ you communicate requests and reviews in your feedback can +have a significant impact on the success of the Pull Request. Yes, landing a +particular change may improve the project, but the individual might just not +want to have anything to do with the project ever again. Having good code ain\'t +the sole goal. ### Abandoned or stalled pull requests -Should Pull Request appear abandoned or stalled, courteously first check -with the contributor to see if they intend to continue the work. Before -checking if they would mind if you took it over (achingly if it just has -nits left). When doing so, courteously give the original contributor -credit for the work they started (either by preserving their name and -email address in the commit log, or by using an `Author:`{.verbatim} -meta-data tag in the commit. +Should Pull Request appear abandoned or stalled, courteously first check with +the contributor to see if they intend to continue the work. Before checking if +they would mind if you took it over (achingly if it just has nits left). When +doing so, courteously give the original contributor credit for the work they +started (either by preserving their name and email address in the commit log, or +by using an `Author:`{.verbatim} meta-data tag in the commit. diff --git a/docs/RATIONALE.md b/docs/RATIONALE.md index 617e7d0..7eb29b4 100644 --- a/docs/RATIONALE.md +++ b/docs/RATIONALE.md @@ -1,102 +1,74 @@ # Rationale -## OrgMode - -> [OrgMode](https://orgmode.org) is one of the best tools for keeping on -> track with what needs to be done and when. And, contrary to myth, it -> doesn\'t need [Emacs](https://www.youtube.com/watch?v=cxoE2FhOIgI), -> just a text editor. Org can be used with a variety of other tools and -> editors once you understand the basics. -> -> Org, at its very heart, is a structured text file. It has headers, -> subheaders, and keywords that allow other tools to parse files into -> agendas and to-do lists. -> -> -- - -Contrary to myth, you don\'t need -[Emacs](https://www.youtube.com/watch?v=cxoE2FhOIgI) to adopt -[OrgMode](https://orgmode.org) - unless you want to. Most flat-text -editor have plugins that help create and manage Org files: - -- -- -- -- - ## Conventional Commits -This project adheres to [Conventional -Commits](https://www.conventionalcommits.org/en/v1.0.0/), [Semantic -Versioning](https://semver.org/spec/v2.0.0.html), and [Keep a -Changelog](https://keepachangelog.com/en/1.0.0/). They can profoundly +This project adheres to +[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), +[Semantic Versioning](https://semver.org/spec/v2.0.0.html), and +[Keep a Changelog](https://keepachangelog.com/en/1.0.0/). They can profoundly intertwine and, when so, they must seamlessly work in concert to fully -appreciate their benefits. With Conventional Commits central to -automation arising from combining these best practices, guaranteeing -that all commits adhere to it becomes paramount. Manually enforcing best -practices and guaranteeing contracts in a code base befalls under the -inadequate and cumbersome category. Thus, this project relies on both -[local tooling](#local-tooling) together with CI pipelines, to make -sure - as best as they can - that changes pushed to this repository -don\'t break contract. +appreciate their benefits. With Conventional Commits central to automation +arising from combining these best practices, guaranteeing that all commits +adhere to it becomes paramount. Manually enforcing best practices and +guaranteeing contracts in a code base befalls under the inadequate and +cumbersome category. Thus, this project relies on both +[local tooling](#local-tooling) together with CI pipelines, to make sure - as +best as they can - that changes pushed to this repository don\'t break contract. ## Semantic Versioning As defined by [Semantic Versioning 2.0](https://semver.org/): -- Patch (1.\_.x) releases *should solely* contain bug fixes or - documentation changes. Besides, these releases shouldn\'t change - runtime behavior. +- Patch (1.\_.x) releases _should solely_ contain bug fixes or documentation + changes. Besides, these releases shouldn\'t change runtime behavior. -- Minor (1.x) releases may contain new functionality, minor dependency - updates, deprecations, and larger internal implementation changes. +- Minor (1.x) releases may contain new functionality, minor dependency updates, + deprecations, and larger internal implementation changes. -> \[!IMPORTANT\] This project automates versioning and adopts [fully -> automated releases](#fully-automated-releases) with +> \[!IMPORTANT\] This project automates versioning and adopts +> [fully automated releases](#fully-automated-releases) with > [`release-plz`{.verbatim}](https://release-plz.ieni.dev). ## Commits and Pull Requests For all information about commits and pull requests, please refer to the -[Contributing](file:///docs/CONTRIBUTING.org#pull-requests) guidelines. +[Contributing](file:///docs/CONTRIBUTING.md#pull-requests) guidelines. ## Intentional Code -Always strive to write [intentional -Code](https://www.youtube.com/watch?v=8j4fhsLcT4k). +Always strive to write +[intentional Code](https://www.youtube.com/watch?v=8j4fhsLcT4k). `Intentional Code`{.verbatim} is much more than avoiding obscure and -incomprehensible variables and functions names; however, these are a -good start give meaning to code. +incomprehensible variables and functions names; however, these are a good start +give meaning to code. ## Documentation -Always write [documentation -comments](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) and -spellcheck them to avoid typos and mistakes. +Always write +[documentation comments](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) +and spellcheck them to avoid typos and mistakes. ## Application Security -This project strives, in [a constantly evolving -process](https://www.schneier.com/essays/archives/2000/04/the_process_of_secur.html), -to apply -[`AppSec`{.verbatim}](https://www.ibm.com/topics/application-security) -[during the entire development life -cycle](https://www.youtube.com/watch?v=hDvz8KivY_U), as best as it can. +This project strives, in +[a constantly evolving process](https://www.schneier.com/essays/archives/2000/04/the_process_of_secur.html), +to apply [`AppSec`{.verbatim}](https://www.ibm.com/topics/application-security) +[during the entire development life cycle](https://www.youtube.com/watch?v=hDvz8KivY_U), +as best as it can. ### Minimum Supported Rust Version -The project strives to stay up to date and on par with Rust releases, to -avoid legacy and stagnation, as `AppSec`{.verbatim} best practices -dictate. +The project strives to stay up to date and on par with Rust releases, to avoid +legacy and stagnation, as `AppSec`{.verbatim} best practices dictate. ## Local Tooling Besides standardized [tooling](https://www.rust-lang.org/tools) and -[conventions](https://doc.rust-lang.org/beta/style-guide/index.html), -default `rustfmt`{.verbatim} and `clippy`{.verbatim}, this project -relies on [RustSec](https://rustsec.org) to inspect supply chain, and -[`trufflehog`{.verbatim}](https://trufflesecurity.com) to avoid sharing -secrets in the code base. Likewise, this project relies on +[conventions](https://doc.rust-lang.org/beta/style-guide/index.html), default +`rustfmt`{.verbatim} and `clippy`{.verbatim}, this project relies on +[RustSec](https://rustsec.org) to inspect supply chain, and +[`trufflehog`{.verbatim}](https://trufflesecurity.com) to avoid sharing secrets +in the code base. Likewise, this project relies on [`markdownlint-cli2`{.verbatim}](https://github.com/DavidAnson/markdownlint-cli2) and [`pre-commit-hooks`{.verbatim}](https://github.com/pre-commit/pre-commit-hooks). @@ -104,15 +76,14 @@ All conveniently enforced with [Git Hooks](https://githooks.com). ## Fully Automated Releases -Appropriately implementing Conventional Commits enables [fully automated -releases](https://blog.orhun.dev/automated-rust-releases/). For this -purpose, this project relies on -[release-plz](https://release-plz.ieni.dev). To [automate -changelog](https://release-plz.ieni.dev/docs/changelog/format). To -handle dependency updates, [semantic version -management](https://release-plz.ieni.dev/docs/semver-check), and -[crates.io](https://crates.io) releases. Upon successful pipelines, +Appropriately implementing Conventional Commits enables +[fully automated releases](https://blog.orhun.dev/automated-rust-releases/). For +this purpose, this project relies on +[release-plz](https://release-plz.ieni.dev). To +[automate changelog](https://release-plz.ieni.dev/docs/changelog/format). To +handle dependency updates, +[semantic version management](https://release-plz.ieni.dev/docs/semver-check), +and [crates.io](https://crates.io) releases. Upon successful pipelines, `release-plz`{.verbatim} invokes -[cargo-dist](https://opensource.axo.dev/cargo-dist/) to create GitHub -releases and packaging for various platforms, along with binary -artifacts and installers. +[cargo-dist](https://opensource.axo.dev/cargo-dist/) to create GitHub releases +and packaging for various platforms, along with binary artifacts and installers. diff --git a/spellcheck.dic b/spellcheck.dic deleted file mode 100644 index 58fee9e..0000000 --- a/spellcheck.dic +++ /dev/null @@ -1,26 +0,0 @@ -27 -& -+ -< -= -> -\ -~ -— -CLI -DAW -DAWs -Ableton -Reaper -Renoise -Bitwig -macOS -freesound -Aner -Andros -commitlint -trufflehog -homebrew -io -metadata -md diff --git a/spellcheck.toml b/spellcheck.toml deleted file mode 100644 index 3e97006..0000000 --- a/spellcheck.toml +++ /dev/null @@ -1,26 +0,0 @@ -dev_comments = false -skip_readme = false - -[Hunspell] -lang = "en_US" -search_dirs = ["."] -extra_dictionaries = ["spellcheck.dic"] -skip_os_lookups = true -use_builtin = true - -[Hunspell.quirks] -allow_concatenation = true -allow_dashed = false -check_footnote_references = false - -[NlpRules] -# Allows the user to override the default included -# exports of LanguageTool, with other custom -# languages - -# override_rules = "/path/to/rules_binencoded.bin" -# override_tokenizer = "/path/to/tokenizer_binencoded.bin" - -[Reflow] -# Reflows doc comments to adhere to adhere to a given maximum line width limit. -max_line_length = 80