Skip to content

Latest commit

 

History

History
63 lines (50 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

63 lines (50 loc) · 3.11 KB

Guide to Contributing

Team Norms

Team Values

  • Workload distributed equitably amongst team members during sprint planning.
  • Each member is expected to keep up with their tasks, and to communicate obstacles to the team as early as possible.
  • If a team member needs help with a task, they should communicate as such in the Discord channel as early as possible, so that the issue at hand can be discussed in the next Daily Standup.
  • All broad scope planning and coordination should take place in the public discord channel.
  • Conflicts should be discussed with the entire group present so as to maintain transparency, and ensure each group member has equal input on the resolutions.

Sprint Cadence

  • Two week sprint length.

Daily Standups

  • Daily standups occur 3 times a week on 5 p.m. EST Sunday, 9 p.m Tuesday, and 9 p.m Thursday, ideally in person.
  • Every member is expected to participate in each standup, except in emergency cases.
  • Scrum Master sure ensure that meetings are concise, and that each member answers the three questions:
    • What did you do since last standup and is it finished?
    • What are you working on now?
    • What problems / blockers do you have, if any?
  • Team members should aim to resolve blocking issues presented in standup by the next standup.

Coding Standards

  • All team members will use Visual Studio Code as their designated editor.
  • Code for each task must be peer reviewed before merging with main branch.
  • Always ensure code is working before merging with main.
  • Aim to make small commits, per feature or bug fix, and always provide concise and descriptive commit message.
  • Delete commented out code before merging with main.

Concluding Thoughts

  • Our team is very excited to both exercise our existing skills and learn more throughout the development of this project in terms of both our individual abilities, and our ability to work as a group. We aim to follow our team values as they are laid out here, but acknoweledge that as we get further into this project we may find ways to improve upon our group workflow, and thus our initial plans are subject to change.

Git Workflow

  • Each team member is to complete their portion of the work in their own local clone of the main repository.
  • Coding standards regarding merging with the main branch as per the Coding Standards section of this document should be strictly adhered to.
  • Potential contributers should clone the main repository to their own machine, preferably using Visual Studio Code's integrated source control for consistency with team members.
  • Pull requests should be made with small changes, and be accompanied by descriptive messages detailing the changes made.

Local Environment Setup Instructions

  • Environment variables are shared among group members (and stakeholders) elsewhere.

Build and Test Project Instructions

To run the server on local machines, from the root directory:

  1. cd front-end
  2. npm install
  3. npm run build (alternatively, npm run build-win on Windows)
  4. cd ..
  5. cd back-end
  6. npm install
  7. npm start
  8. visit http://localhost:8080 (the default port)