wbond / packagecontrol.io

The Package Control website
https://packagecontrol.io
Other
111 stars 46 forks source link

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

Open kukimik opened 1 year ago

kukimik commented 1 year ago

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.