Skip to content

Commit cf666fe

Browse files
committed
Add a list of future improvements to readme
Signed-off-by: Martin Prpič <martin.prpic@gmail.com>
1 parent 593c1ca commit cf666fe

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,16 @@ commit-editor path/to/file.txt
6060
This editor enforces the widely-accepted git commit message conventions:
6161

6262
1. **Title (line 1)**: Should be 50 characters or less; characters beyond 50 are highlighted in red as a warning.
63-
6463
2. **Blank line (line 2)**: Separates the title from the body.
65-
6664
3. **Body (line 3+)**: Should wrap at 72 characters; long lines are wrapped automatically as you type.
6765

66+
## Future Improvements
67+
68+
- Support adding a "Co-authored-by" trailer for AI attribution
69+
- Word-level spellchecking
70+
- Config file support (`.commit.toml` project or global level or `pyproject.toml`); support tweaking line length limits
71+
- Jira (or other issue tracker) ID checking (e.g. title starts with `ABC-123: `)
72+
6873
## License
6974

7075
MIT

0 commit comments

Comments
 (0)