Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (65 loc) · 5.91 KB

CONTRIBUTING.md

File metadata and controls

88 lines (65 loc) · 5.91 KB

Contributing to Code Mentoring

We're so glad you're here! This document will outline how we work, who's involved, and general information on how you can get started on this fun project.

⛑ Available roles:

  • Front-end: Works on the client with React, CSS, etc
  • Back-end: Works in the api with NestJS, Node.js, Express, databases, etc
  • Full-stack: Works across both client and api
  • Designer: Works in Figma/other tools to design new user stories, envision product features, etc

👨‍💼 Who's involved?

This is a running list of those who are actively contributing to this project.

🧢 Maintainers

A 🧢 next to someones name means they are a maintainer. These people are considered the project's leaders and core contributers. Please treat them with the respect you would give your boss. They are here to help us 😀 and make the project grow smoothly. If they ask for something, please 🙏 listen to what they say carefully. All maintainers are approved through Code Mentoring's leadership team.

The Team

Name Role Slack handle Github Weekly Availability Joined
🧢 Tristan Matthias Project Lead @Tristan Matthias @tristanMatthias 20 hours Apr 2020
🧢 Shane Sheridan Scrum Master @Shane Sheridan @shane215 6 hours Apr 2020
🧢 Quim Granados Full-stack @Quim Granados @quimgv 10-20 hours Apr 2020
🧢 Rajat Bansal WWW Lead @Rajat Bansal @rjtbansal 15-20 hours Apr 2020
Frank Kim Documentation / Front-end @Frank Kim @heyfranksmile 10 hours Apr 2020
Frankie Law Full stack @Frankie @FrankieLaw 5-10 hours Apr 2020
Suzy Nakayama Full-stack @Suzy Nakayama @suzynakayama 10 hours Apr 2020
Tomoya Kuroda Full-stack @Tomoya @tomoyakuroda 10 hours Apr 2020
Ellie Xiang Full-stack @Ellie. @Ellie-2020 8+ hours Apr 2020
Folke Westergren Front-end @Folke @f-westergren 5-10 hours Apr 2020
Weiwei Zhang Front-end @Weiwei Zhang @wzhang66 5-10 hours Apr 2020
Ahmed Alhassan Front-end @Ahmed Alhassan @ahmedfaaid 8 hours Apr 2020
Lee Yang Back-end @Lee @LeeYang2019 5-10 hours Apr 2020
Kevin Gilbert Back-end @Kevin @NoSoEpicCoder 5-10 hours Apr 2020
Rayser Castrillo Back-end @rayser @raysercast1 5 - 10 hours Apr 2020
Lan Phan Testing & Front-end @Lan Phan @lanphantastic 3 - 6 hours Apr 2020
Dwane Pennant Back-end @Dwane @pennandw 2 - 5 hours Apr 2020

🔧 What can I work on?

We use Github to track our issues. Look for any issues labelled help wanted. If there is nobody assigned, comment that you'd like to take it over, and a maintainer will assign you.

You can view all issues needing help here

💬 Communication

We use our Slack community (#project-cm channel) for discussions on the project, and Github projects for tracking issues.

We also have a weekly standup call at 6pm EST on Hangouts. Message one of the maintainers for access to slack or to get a meeting invite.

🏃🏻‍♀️ Sprints

We do monthly sprints with weekly standups at 6pm EST on hangouts. This means each month we deploy to master with all the PRs that were done that month.

🌳 Branches

We use the Git Flow branching strategy to maintain the project. PLEASE FOLLOW THIS FORMAT

  • master Production branch. Limited access on who can deploy to this
  • develop Main development branch. We merge feature/* PRs into this branch once they're approved
  • feature/* A feature branch aimed at addressing a SINGLE feature/fix. We try to keep these as SMALL AS POSSIBLE so our PR reviews are not to challenging. If a maintainer asks you to reduce your PR size, please do so.
  • release/vX.X.X Used to release the sprints work into production.

PRs

As per git flow, all PRs should be on branches with the names feature/name-of-feature. They should be requested to merge into the develop branch, NOT THE master branch.

When a PR is ready, please make sure to request a review from a 🧢 maintainer. Once the maintainer has approved your PR, it will be merged for you into develop. Congratulations 🎉! #alwaysbeshipping ⛵️