Skip to main content

Posts

Showing posts with the label lint

How to correctly format README files?

The README files are generally made in markdown syntax which you can learn from these links for Github : https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet for BitBucket : https://confluence.atlassian.com/bitbucketserver/markdown-syntax-guide-776639995.html ​​​​​​​ As markdown syntax is pretty much flexible, so many times same text renders in different way on various platforms. This happens because most of the people make very common mistakes while creating the markdown files. Those mistakes may not get visible on their local editors but become clearly visible when the markdown file gets hosted on popular code repositories like Github, Bitbucket, Azure, etc. So to overcome this issue it is recommended to use some kind of markdown linters which force creator to use standard syntax while making markdown files. For the same purpose, I have found quite impressive linter https://textlint.github.io/ that we should use. So to use it, you can copy the content of README file int...