Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve zulint documentation in README.md #1

Open
Sai-Adarsh opened this issue Feb 13, 2019 · 1 comment
Open

Improve zulint documentation in README.md #1

Sai-Adarsh opened this issue Feb 13, 2019 · 1 comment

Comments

@Sai-Adarsh
Copy link

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?
@timabbott
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@timabbott @Sai-Adarsh