diff --git a/README.md b/README.md new file mode 100644 index 0000000..0091791 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +A plugin for JetBrains IDEs that automatically prefixes commit messages with information extracted from branch names. + +Features: +- Extract information from branch names using configurable regex patterns +- Format commit messages using configurable format patterns +- Enable/disable the plugin from the commit dialog + +The branch name extraction pattern is configurable from the IDE settings + +Example: +- Branch name: `feature/12345-add-new-feature` +- Commit message: `Initial implementation` +- Result: `#12345 - Initial implementation`