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

Package developer docs do not mention the syntax package naming rule #160

Open
kukimik opened this issue Jan 28, 2023 · 0 comments
Open

Comments

@kukimik
Copy link

kukimik commented Jan 28, 2023

The documentation at https://packagecontrol.io/docs/submitting_a_package#Step_2 does not mention the two rules that are stated in the review guidelines at https://github.com/wbond/package_control_channel/wiki#review-the-pull-request, namely:

Syntax packages should be named after the language, i.e. "LESS", not "LESS syntax" or "LESS highlighting" because syntaxes in ST do much more than just highlighting.
Names should not be misleading regarding its functionality. e.g. .sublime-completions files do not provide "auto-completion", for example.

The second rule is rather obvious, but the first one is not (and many existing packages do not obey it). I found this surprising when submitting a package, and believe the rule should be stated upfront to save the package developers some time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant