Repository navigation
Conventions based on #5 - #7
skycatminepokie wants to merge 6 commits into
Conversation
ddd8e6d to
23ebcc4
Compare
Thomas1034
left a comment
There was a problem hiding this comment.
This seems reasonable as a start for a conventions framework. I think it would be good to elaborate on some of the points, though. For instance, you might want to explain why the given positive examples are good and the given negative examples are bad. A brief paragraph should suffice. I also noticed and commented on a few possible typos; it would be good to resolve those for the sake of professionalism.
Obviously, I'm not an owner or current contributor to this project, so don't consider my comments or suggestions to be binding. However, I thought I'd chip in the two cents of a passing semi-stranger!
23ebcc4 to
09601ab
Compare
Fixed all the typos mentioned. I'm not opposed to elaborating on why things are good/bad as far as what conventions they break, but explaining the motivation behind them might be out of scope. Any second opinions - is mentioning the motivation behind conventions worthwhile? |
modmuss50
left a comment
There was a problem hiding this comment.
Looks good to me, I dont think we should bikeshead this more than necessary, it can always be tweaked later.
cassiancc
left a comment
There was a problem hiding this comment.
This all seems reasonable, and can be expanded later as necessary.
Thomas1034
left a comment
There was a problem hiding this comment.
I think that looks good to me. I didn't see any overt and obvious errors or typos.
NotNightSky
left a comment
There was a problem hiding this comment.
Looks good to me. It's simple and effective.
Starting conventions, yay! Based on #5 , I think I addressed all the problems mentioned there. Though I did remove the bit about capitalization of in-game things.
Generally trying to help find something agreed-upon, I don't think I have any strong opinions on conventions.
I tried to make a stacked pull request, but GitHub said "hey you can't do that, your branch has to be in the same repo! no forks!"