refugerestrooms icon indicating copy to clipboard operation
refugerestrooms copied to clipboard

Create style guidelines

Open johana-star opened this issue 10 years ago • 7 comments

The project should have clear style guidelines for contributors. Let's add a style guideline to the contributing guide. I would recommend that we default to the [https://github.com/bbatsov/ruby-style-guide](ruby Style Guide) except when it does not specify a guideline, in which case we should make a project specific guideline and retain specificity towards that.

What do you think @tkwidmer and @kiesia?

johana-star avatar Aug 18 '14 05:08 johana-star

I'm totally happy to follow houndci's recommendations. I think they make a lot of sense, and it's a big win to have everyone writing code in the same style. That said there are often times where they shouldn't be applied, like on generated code.

kiesia avatar Aug 18 '14 05:08 kiesia

we can customize houndci so that it fits our own styleguide exactly. I thinking using hound is going to be really good as we move forward so that our code will stay as uniform as possible.

https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml

tkwidmer avatar Aug 18 '14 17:08 tkwidmer

the details about how to configure are here: https://houndci.com/configuration

currently its using the default thoughtbot styleguide

tkwidmer avatar Aug 18 '14 17:08 tkwidmer

To complete one should concurrently:

  • [ ] Create a style guide
  • [ ] Configure Hound to follow that style guide

I'm interested but low bandwidth as per usual.

johana-star avatar Aug 18 '14 18:08 johana-star

same. bandwith has been a problem for me lately.

tkwidmer avatar Aug 18 '14 19:08 tkwidmer

I've turned off hound until we get the styleguide in place.

tkwidmer avatar Dec 27 '14 19:12 tkwidmer

Hey @strand! :) I’d love to help create a style guide for working with the product’s documentation. It’ll help contributors gain experience in tech writing and give non-coders a way to support the project.

CBID2 avatar Jun 17 '23 15:06 CBID2