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.

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

Specify Zulip coding conventions/styles/approaches ZT follows #1523

Open
neiljp opened this issue Jun 20, 2024 · 0 comments
Open

Specify Zulip coding conventions/styles/approaches ZT follows #1523

neiljp opened this issue Jun 20, 2024 · 0 comments
Assignees

Comments

@neiljp
Copy link
Collaborator

neiljp commented Jun 20, 2024

Description of documentation

Documents such as https://zulip.readthedocs.io/en/latest/contributing/code-style.html are very good for Zulip as a whole, but inevitably include references to tools/languages that we do not use.

There are also cases where it is useful to call out elements that are specific to ZT, or emphasize particular aspects that come up repeatedly.

This may need discussion to refine, but a draft could pick out some definite points regarding at least:

  • naming (general, ~private object methods, bool-returning, abbreviations, ...)
  • docstrings (files, functions, classes, ...; which classes/functions benefit most/least)
  • structuring functions (including *, and / in future)
  • typing (possible link to Zulip doc for that - https://zulip.readthedocs.io/en/latest/testing/mypy.html)

As per the linked document, this is for helping clarify style that is not easy to enforce in some other way, such as via linters.

Most recently noted at:
https://chat.zulip.org/#narrow/stream/206-zulip-terminal/topic/Developer.20Docs.20.23T27/near/1785160

@neiljp neiljp self-assigned this Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants