Skip to content

Commit

Permalink
docs: add todos/ideas in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthias Zaunseder committed Jan 23, 2024
1 parent 078c4f5 commit 00f57d2
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,16 @@
> A commitlint implementation in Rust.
It's a project to learn Rust, so don't expect production ready code. If anybody has suggestions to make it better, please feel free to open an issue!

## Todos/Ideas:

1. Configuration system
2. Implement more rules (see [commitlint rules](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/rules/src))
3. Implement unit tests for rules
4. Allow multiple lines in footer and parse references (like original commitlint)
5. Use and parse CLI args (probably with [Clap](https://docs.rs/clap/latest/clap/index.html))
6. Publish on npm
7. Dogfood it to lint our own commit messages
8. Benchmark against original [commitlint](https://github.com/conventional-changelog/commitlint)
9. Migration docs from original commitlint to commitlint-rs
10. Allow 3rd party rules? Maybe WASM?

0 comments on commit 00f57d2

Please sign in to comment.