Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 2.17 KB

Contributing

Join the Team

Team discussions will take place in Slack. Join @ https://mcac.slack.com/signup.

Recommended Reading

If you're starting from scratch here are a couple guides that will help you out:

If you're more of a visual person, here are also some really good talks:

Style Guides

You don't need to memorize these but try to read them once to know what to keep an eye on. Keeping a readable/consistent code base is one of the key ways to keep everything sane.

Workflow

We'll be loosely following the Feature Branch Workflow:

  • Avoid commiting code directly on master
  • Create a feature branch for every issue you're working on
  • Submit a pull request for every completed feature
  • Code review all pull requests before merging into master
  • master should always contain what's currently on production

Code Reviews

For now, Amos will be doing most of the code reviews until things get rolling. A couple things that you should look out for before even submitting the pull request for code review:

  • Keep the test coverage at or above the current level or have a good reason why a test is not needed.
  • Keep the code climate at or above the current level unless there's a good reason to lower it.

Lastly, have fun! There's no room for egos, we're all just here to learn and discuss about code.