Skip to content

Latest commit

 

History

History
80 lines (71 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

80 lines (71 loc) · 3.77 KB

Contributing Guide

Getting Started

  • Be sure to go over the README
  • The wiki pages (to be added soon) contain detailed information about this project's architecture and how the various files in this project are structured
  • If you are not a member of the CollabCloud organization on GitHub, you may request to join by contacting one of the developers
  • We use GitHub Issues to track work that needs to be done (similar to user stories), and GitHub Projects to track the progress of these issues (similar to a Kanban board)
    • If there is something you want to work on, feel free to create the issue here!

Coding Styles

The following coding styles must be followed:

  • Ensure that you add comments when appropriate for the code you write
  • All JavaScript syntax should follow ES6:
    • Use let instead of var
    • Use const when appropriate
    • Use arrow functions when appropriate

Git Flow

  • We use master branch, a dev branch, and various feature branches
    • Both master and dev branch should contain working, presentable code
    • The master branch contains live code that is deployed
    • Branch off of dev when working on new issues
    • Use one feature branch per issue
  • When you create a feature branch, ensure that what you are working on is being tracked as an issue and is in a project!
    • Be sure to give it a descriptive name and prefix it with the issue number in the following manner:
      • COL-1NNN-InsertDescriptiveName, where NNN is the issue number

Commits

  • Please include a descriptive commit message
  • Feel free to use emojis
  • Commit messages must be prepended by COL-1NNN, where NNN is the issue number
    • Example: 
      $ git commit -m 'COL-1NNN :pencil: Create front-end components for displaying project comments'
  • Push to the branch

Pull Requests

  • When you are making a pull request, you are requesting that your feature branch is merged back to the dev branch
  • Pull requests must be reviewed and approved by two other members of the project before they can be accepted
  • Use this checklist to ensure you are making a good pull request:
    • My code works!
    • My code doesn't (to my knowledge) break any other pre-existing code
    • I have resolved merge conflicts
    • I have documented my code appropriately
    • My code follows the appropriate coding styles for this project

Example Workflow

  • Ensure that you are on the latest version of the dev branch 
    $ git checkout dev
$ git pull
  • Create a new feature branch 
    $ git checkout -b COL-1054-AddProjectComments
$ git push --set-upstream origin COL-1054-AddProjectComments
  • Add and commit your changes 
    $ git add ProjectComment.js
$ git commit -m 'COL-1054 :pencil: Create front-end component for displaying project comments'
  • Push changes 
    $ git push
  • Once you are satisfied with your changes, make a pull request
    • See guidelines here

Thank you for contributing to CollabCloud!