search

kalepail / tiny-money-webpack

A fully featured open source budgeting application
MIT License
4 stars 0 forks source link

Contributor guidelines / style guide / standards #4

Open curtisblackwell opened 7 years ago

curtisblackwell commented 7 years ago

It would be helpful to have contributor guidelines. I'd want to see info on getting up and running and style guides in there. Style guides could probably just point to appropriate lint configs in most cases, though. Vue has a new style guide that I think would be good to follow.

I noticed a couple things that break convention / I'm curious about:

  1. Files don't consistently have a single trailing new line.
  2. Single word component names are invalid.
    Source (see the second green box.)
  3. Not using .vue files in a Vue project.
    I get not wanting to put the styles in .vue files, I always find that to be tedious when focusing on styles, but I always find it convenient to have the JS and template in there.
  4. The ESLint config doesn't seem to have any opinions on style, which I fear will lead to things getting messy. I already see we have different preferences, which is all good, I'd just like to be consistent and setting ESLint up more thoroughly will help quite a bit. I tried using the automatic configuration method, but it can't find the files for some reason.
  5. Why not use Vue's official webpack setup? If you're cool with that, I can re-configure things sometime this week.
kalepail commented 7 years ago

All good thoughts. The answer to most is I either had no idea or I simply don't care. I agree some contributor guidelines are a good idea and I'm 100% behind using all the Vue and Webpack conventions. I just know my role here is a bit higher level than the code quality / consistency.

If you're willing or able to bring some of these thoughts into the code base I'll be happy to comply.

Thanks for the ideas and for the detailed points.

curtisblackwell commented 7 years ago

@tyvdh Should I fork or do you want to give me access to this repo?

kalepail commented 7 years ago

@curtisblackwell It's an open source project. Are you not able to pull and create PRs? The branch/PR method would probably be my preference.

With that said I'll go ahead and invite you since I know and trust you and you've already got a decent grasp of Vue.

curtisblackwell commented 7 years ago

I can fork, but not push a new branch. Agreed on branch/PR.