Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create style guidelines #165

Open
johana-star opened this issue Aug 18, 2014 · 7 comments
Open

Create style guidelines #165

johana-star opened this issue Aug 18, 2014 · 7 comments

Comments

@johana-star
Copy link
Contributor

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?

@kiesia
Copy link
Contributor

kiesia commented Aug 18, 2014

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.

@tkwidmer
Copy link
Contributor

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
Copy link
Contributor

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

currently its using the default thoughtbot styleguide

@johana-star
Copy link
Contributor Author

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.

@tkwidmer
Copy link
Contributor

same. bandwith has been a problem for me lately.

@tkwidmer
Copy link
Contributor

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

@CBID2
Copy link

CBID2 commented Jun 17, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants