Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 3.47 KB

Contributing to GoodOldMap

I. Roles

  • Product Owner: Nina Xiao
  • Scrum Master: Tracy Zhang

II. Team Values

  • Team members collaborate by interacting on our Discord and WeChat group chats, evaluating one another's work on Github, and monitoring each other's advancements through Standups.
  • If team members encounter challenges or disputes, they should raise these concerns during daily standups to the product owner and scrum master. These leaders assist the team in devising solutions. We anticipate that team members will reply to messages within a maximum of 2-3 hours.

III. Daily StandUp

Our regular StandUp schedule: Tue/Thu 2pm EST, Friday 2pm EST.

Should there be any changes to the above schedule such as time change or additional standups, scrum master is to be informed no less than 24 hours in-advance, otherwise the regular meeting schedule will be honored.

During daily standup meetings, every member needs to answer three questions:

  • What have you done since last time?
  • What are you doing now?
  • Is there anything blocking your progress?

Scrum master records every member's progress and problems (answers to the above three questions) and post them on the daily standup channel on Discord.

IV. Rule of Contributing

First off, any types of contributions is valued and encouraged. Before you start on any specific contributions, please read our relevent documentations to better understand the project or see if the problem is resolved. This would be more easier for us project maintainers.

  • If there's a question, we welcome you to open a issue and descrcibe as detailed as possible

V. Git Workflow

To make any editions to the project, please follow the below procedures.

  • After done with the changes on local copy, use git status to check the status to the project
  • Use git add . to stage the changes
  • Use git commit -m "summary of the staged changes"
  • git push origin master(main branch) and create a pull request.
  • When creating a pull request, please follow the syntax:

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Change List

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

To resolve any merge conflicts, we recommend you to use rebase to resolve conflicts or simply use web merge conflicts editor.

VI. Set Up Environment

  • To set up the environment, please first fork the project and save a copy of the project in your github
  • Use git command or git desktop to save a local copy to your computer
  • open a terminal, enter either front-end or back-end folder to use the command npm -i. This will help you to install all neccessary dependencies for the project.

VII. Build & Test the Project

  • We use React as the front-end, so when you want to build the project, open the terminal and type npm -start. Make sure to copy paste the localhost and the corresponding port website to your browser.

Guide to Contributing

Delete the contents of this file and replace with the contents of a proper guide to contributing to this project, as described in the instructions