search

AztecGameLab / LongTermGame7

0 stars 0 forks source link

create code style guides #9

Open poetahto opened 1 year ago

poetahto commented 1 year ago

We actually did try and make one of these in previous years, but it was kinda dense and didn't get enforced very well. I think it was the right idea, just the wrong implementation.

Lets try and figure out automated ways for ensuring code style. There are a couple things I want to look into: 1) IDE specific linters (or IDE agnostic - that would be better!) 2) github actions? (this stuff?)

honestly, github actions is a whole rabbithole, but looks kinda cool (for example, automatically running automatic styling whenever you make a pull request - you dont even need anything installed on your computer). If we want to mess around with testing and test coverage, it might be cool to look into, @chmilk1 (although i have had very mixed results trying to figure out a good automated testing workflow with Unity in the past)

poetahto commented 1 year ago

Some interesting updates: EditorConfig Files (More Info) StyleCop and SonarLint

And finally, our style guide from last fall.

poetahto commented 1 year ago

https://dotnetanalyzers.github.io/StyleCopAnalyzers/ sonarlint rational