stevedlawrence commented on pull request #42:
URL: https://github.com/apache/daffodil-vscode/pull/42#issuecomment-953067469
The issue was that it's all on one line. From the wiki page:
> Ensure the commit has an appropriate and descriptive commit message.
The first line of a commit message should contain a short (~50
characters) description of the changes. The second line should be blank,
followed by a longer description of the change, wrapped at 72
characters. This long description should describe what was changed in
the commit and, more importantly, why those changes were made. The
'what' can be determined by inspecting the code, but the 'why' is often
less obvious. At the end of the commit should be a blank line followed
by a reference to the JIRA bug, e.g. DAFFODIL-123. Multiple bugs
referenced in a single commit should be separated by a comma on the same
line. An example of a commit message is:
> ```
> Add support for the dfdl:bitOrder feature
>
>Longer explanation of what changes were made to support the bitOrder
>feature, including a description of why the changes were made. Multiple
>lines are wrapped at 72 characters
>
>DAFFODIL-123
>```
So an improved commit message for this commit might look something like this:
```
Add Apache Rat Check
- Remove sbt-header plugin, license headers should be added manually
and checked with Apache Rat
- Add CI for running the Rat Check
- Update the headers for most of the code that had a CTC/Nteligen
header in it.
Closes #27, #32, #36
```
Note that the long description might not be needed if the short description
is sufficient. Though, I've never complained that a commit message had too much
information it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
