readme.so VS commitlint

Use the editor at readme.so

Here's the link : https://readme.so/

Keep your project's readme organized and attractive with Readme.so. The simple editor allows you to quickly add and customize all the sections you need for your project's readme.

You should make a better README file (https://readme.so/ can help)

readme.so

Hay. I just discovered this VS code extension called Readme Editor developed by SumitNalavade. This is much like readme.so but embedded in to VS code, in other words this a README file editor that helps you edit README files for GitHub and is embedded into VS code. There are also lot of templates that you can start your README.md file with. And Once you click the save button your README.md file is automatically saved to your root folder.

After coming cross this feature request, I decided to go ahead and build it myself .

Apart from these we also need to enforce standards for all our commit messages(commit-lint).

There are many features of commitlint that I can't mention one by one, as well as installation guide. To know the detail you can directly access https://github.com/conventional-changelog/commitlint.

These commit message prefixes can help to provide context and organization in a project's version control history, making it easier to understand and track changes over time. Note: if you want to force these rules on commit messages, here is a commit linting lib for you. Commitlint

Commit Lint

I personally find it quite useful to enforce a uniform commit style. commitlint pairs well with husky.

⧗ input: Set up Conventional Commits using Husky and commitlint ✖ subject may not be empty [subject-empty] ✖ type may not be empty [type-empty] ✖ found 2 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint husky - commit-msg hook exited with code 1 (error)

Can setup tools like Commitlint to add hooks that will reject a commit message if it is invalid, but if you format a commit message incorrectly it simply closes the commit buffer and returns to git status, meaning you have to retype out your commit message, which is obviously less than ideal.

✅ Angular 14 ✅ Angular Material ✅ Unit Testing with Jest ✅ End-to-End Testing with TestCafé ✅ Internationalization with Transloco ✅ Auto documentation with Compodoc ✅ Analyse your project with source-map-explorer ✅ Docker ✅ ESLint ✅ Prettier ✅ Commit Linting