zulint icon indicating copy to clipboard operation
zulint copied to clipboard

Published 20 hours ago • verified publisher icon zulip

Improve zulint documentation in README.md

Open Sai-Adarsh opened this issue 6 years ago • 1 comments

This repository needs a guidance on code base of the Zulint. Writing proper documentation in the README.md would be good.

Something like these.

  • Docs explaining zulint
  • Usage of zulint in Zulip developer's workflow.
  • What does zulint/printer.py do?

Sai-Adarsh avatar Feb 13 '19 04:02 Sai-Adarsh

This project isn't ready for distribution yet; we got halfway through extracting the project from zulip/zulip as a resuable component a few months ago, but I don't intend to update this until we do the other half.

timabbott avatar Feb 14 '19 23:02 timabbott