How to format commit messages for plugins?

Community Contributions & Discussions
1

Hello!

I am formatting the code of the E-mail Incident Notification Plugin so that it matches Camunda guidelines.

In the section on commit message conventions I read that the commit messages should have the following format:

<type>(<scope>): <subject>

<body>

<footer>

I assume that in my case the initial commit message should look like this:

feat(engine-plugins): E-mail Incident Notification Plugin

- Allows to send e-mails when incident occur.
- List of recipients can be configured on a per-process basis (in BPMN diagrams) with a fallback recipient list in the configuration file.
- Incident buffering: The plugin can be configured so that it only sends e-mails in certain intervals. That is, if there are 1000 incidents per minute and the plugin is configured to send an e-mail once per hour, one e-mail will be sent (and not 1000).

related to CAM-XXXX

where CAM-XXXX is the number of the ticket.

I have following questions:

  1. Is the <scope> (engine-plugins) correct?
  2. Where exactly can I create the ticket (how can I get the CAM-XXXX number)?
  3. Are there any other errors in the above commit message?

Thanks in advance and a happy new year!

Dmitrii Pisarenko