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

Add Style Guide to CONTRIBUTING.md #189

Open
ChaelCodes opened this issue Oct 12, 2020 · 0 comments
Open

Add Style Guide to CONTRIBUTING.md #189

ChaelCodes opened this issue Oct 12, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation Needs Research question Further information is requested

Comments

@ChaelCodes
Copy link
Owner

Describe the Feature

Is your feature request related to a problem? Please describe.
There are a few things that I consider Antipatterns in the Rails community, like tests on model validations. These aren't catchable by Rubocop, and if they're part of a PR, I'd let them slide, but I do want to guide others away from using them.

Describe the Technical Implementation of the Solution

Solution
Add a section to the CONTRIBUTING.md called a style guide and mention uncommon decisions there.

Please comment on this issue with thought and recommendations for the Style Guide.

@ChaelCodes ChaelCodes added documentation Improvements or additions to documentation question Further information is requested Needs Research labels Oct 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Needs Research question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant