[Request] Add a contributing guideline. about livetl HOT 12 CLOSED

Solved with commit 7fb2c51e769c92b66e328598641db264870b14c9.

from livetl.

@r2dev2bb8 I would like to have this re-opened. I do not think that the original issue was addressed as I would also like to make potential code changes but do not have a standard to write code to.

For example, a commonly used standard is:
https://standardjs.com/rules.html

This allows for anyone to write code that looks the same across all IDEs and not massively change the code style per contributor. Sometimes the actual module is included as a dev-dependancy, though it is not necessary in all projects as long as a specific code style guide is provided.

from livetl.

I also really don't want to auto-format all the code to some random style that I use and mess up the entire visual of the repo

from livetl.

The standard you provided seems pretty good, although our code is not currently formatted exactly to that. @KentoNishi, are you fine with the standard given by @Bob620? Also, can our repo be autoformatted to fit that style?

from livetl.

Sure yeah, my formatter in vscode is only configured to do tabbing and stuff so I can just change it to two spaces. Idk if this is because I write in other languages but I always use four spaces rather than two. Obviously I realize for JS two is more appropriate. Go ahead!

from livetl.

I usually use tabs so that you can set the actual depth to whatever the user wants, its all down to preference with styles, just want to have a consistent style.

from livetl.

@Bob620 could you submit a PR with the proposed formatting style?

from livetl.

There's an extention for vscode that automatically formats to those standards: https://marketplace.visualstudio.com/items?itemName=chenxsan.vscode-standardjs

from livetl.

So @Bob620, can you change CONTRIBUTING.md to say to use this but with semicolons.

from livetl.

Now that's epic, gonna install later. Anyone else can go ahead with the formatting changes, I need to go eat dinner XD

from livetl.

there's a version of the standards that essentially does what you said but in an actual standard
https://github.com/standard/semistandard
the vscode formatted also supports that

from livetl.

Are there any more concerns about this issue?

from livetl.