README.adoc in git-lint-2.3.2 vs README.adoc in git-lint-2.3.3
- old
+ new
@@ -16,12 +16,15 @@
[link=https://travis-ci.org/bkuhlmann/git-lint]
image::https://travis-ci.org/bkuhlmann/git-lint.svg?branch=main[Travis CI Status]
[link=https://app.netlify.com/sites/git-lint/deploys]
image::https://api.netlify.com/api/v1/badges/7e23b422-3412-4e7f-b654-65c0417a0b1f/deploy-status[Netlify CI Status]
-A command line interface for linting Git commits. Ensures you maintain a clean, easy to read,
-debuggable, and maintainable project history.
+Git Lint is a command line interface for linting Git commits by ensuring you maintain a clean, easy
+to read, debuggable, and maintainable project history. Having a consistent commit history leads to
+improved code reviews and is a perfect companion to tools like
+link:https://www.alchemists.io/projects/milestoner[Milestoner] for versioning and producing
+automated release notes of your deploys.
toc::[]
== Features
@@ -900,11 +903,12 @@
repositories to better organize and split out this work. Sophisticated package managers, like
link:https://bundler.io[Bundler], exist to manage these dependencies better than what multiple Git
Submodules can accomplish.
* Avoid using link:https://git-lfs.github.com[Git LFS] for tracking binary artifacts/resources.
These files are not meant for version control and lead to large repositories that are time
- consuming to clone/deploy. Use storage managers, like link:https://aws.amazon.com/s3[Amazon S3]
- for example, that are better suited for binary assets that don't change often.
+ consuming to clone/deploy. Use storage managers, like link:https://aws.amazon.com/s3[Amazon S3] or
+ link:https://lakefs.io[LakeFS] for example, that are better suited for binary assets that don't
+ change often.
=== Security
Ensure signed commits, pushes, and tags are enabled within your global Git Configuration to reduce
an