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 a page about contributing? #43

Closed
solnic opened this issue Feb 2, 2015 · 1 comment · Fixed by #55
Closed

Add a page about contributing? #43

solnic opened this issue Feb 2, 2015 · 1 comment · Fixed by #55
Assignees

Comments

@solnic
Copy link
Member

solnic commented Feb 2, 2015

How about adding a dedicated page with all the information about how to become a contributor? There's a lot of knowledge common for all rom-* projects so it feels wrong to duplicate it in CONTRIBUTING file in each repo.

This page could cover things like:

  • Code style guidelines (probably boils down to "run rubocop" to get feedback however I'm worried that people might be pushed by rubocop to do silly refactorings like breaking down a method into 2 because some artificial limit is exceeded etc.)
  • Basic design principles (avoid mutation, how OO is done in ROM, functional tidbits etc.)
  • Support interface (Equalizer, ClassMacros, Options etc.)
  • Git guidelines (esp regarding squashing, when to, when not to, what to write in commit messages)
  • How to get help and support from core contributors
  • How to find what to work on (it would be freaking cool to dynamically list issues tagged "help-wanted" there!)
@maetl
Copy link
Contributor

maetl commented Mar 18, 2015

FYI, I’ve started working on this.

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

Successfully merging a pull request may close this issue.

2 participants