search

p4t5h3 / purebasic-language-for-sublime-text

PureBasic support for Sublime Text.
MIT License
4 stars 1 forks source link

Set PB Encoding to UTF-8 BOM #38

Closed tajmone closed 2 years ago

tajmone commented 2 years ago

Add a PureBasic.sublime-settings file to the repository defining the default_encoding to "UTF-8 with BOM" for compatibility with the PureBasic IDE. (closes #34)

tajmone commented 2 years ago

On Adding Detailed Comments

Peter, I hope you don't mind me having added some rather verbose comments to the PureBasic.sublime-settings file. In my personal experience with PureBasic projects on GitHub is that for many PB users working with Git and GitHub is a fairly new experience, so providing extra comments that might help newbies make sense of what the various project files do can be of great help.

Also, since usually enforcing syntax settings in packages is frowned upon, providing a detailed justification is justified.

But I strongly believe that adding a few lines of extra comments can be really useful for Git newbies — we've all been there, and we know how frustrating it can be to learn Git, not to mention all the extra layers added by the GitHub service and other third party tools (from CI services settings to EditorConfig, you name it).

Sometimes, all it takes to make a newbie's day is providing a commented paragraph and a reference link. Even Sublime Text provides useful comments in its syntax templates, settings files, etc., so it's in the spirit of the ST community to make thins easy.

I'm aware that many developers tend to keep comments down to the minimum, based on the assumption that contributors should have the required know-how. But I prefer to leave behind tips that can help beginners find their way; I think it's a form courtesy that makes sense in projects like this, and it doesn't really cost much either.