Skip to content

Latest commit

 

History

History
121 lines (91 loc) · 4.48 KB

CONTRIBUTING.md

File metadata and controls

121 lines (91 loc) · 4.48 KB

Guide to Contributing

The Team Norms

Team Values

  1. Collaboration - Value teamwork and cooperation.
  2. Communication - Value clear, transparent, and open communication.
  3. Adaptability - Value flexibility and adjustability.
  4. User focus - Value user satisfaction and delivering value.
  5. Continuous improvement - Value reflection, learning, and improving processes.

Sprint Cadence

  • Sprint 0: 02/15-02/27
  • Sprint 1: 02/27-03/22
  • Sprint 2: 03/22-04/10
  • Sprint 3: 04/10-04/24
  • Sprint 4: 04/24-05/03

Daily Standups

  • Pre-Scheduled Daily Standups are to be held the evening of the days lecture is held, Monday and Wednesdays. The third Daily Standup of the week/sprint is to be scheduled through when2meet.
  • After a daily standup session, the scrum master of the sprint is to organize all the members' daily standup and paste them with a labeled date onto the "team_driply_standup" channel.

Planning Poker

  • Work estiminations for users stories are decided using planning pokers with the created cards.
  • Part 1
  • Part 2
  • Part 3

Coding Standards

  • Visual Studio Code as IDE
  • Make small commits and stick to the workflow below

The Git Workflow

  1. Pull recent changes
    git pull origin master

  2. Create branch. Choose a branch name for what feature you’re doing
    git checkout -b <branch-name>

    example:
    git checkout -b user-story/13/task/9/implement-user-login

  3. Update task board TASK to “In Progress”

  4. Add and commit
    git add .
    git commit -m “<message>”

  5. Merge remote changes
    git fetch origin
    git merge origin/master

  6. Push branch changes to YOUR BRANCH
    git push origin <branch-name>

  7. Go on github, go to your branch and go to PULL REQUESTS. Create a pull request to push your branch into the main branch

  8. Update task board TASK to awaiting review

  9. AFTER someone else reviews, approves and merges your code, delete your branch
    git push origin -d <branch-name>
    THEN switch back to master
    git checkout master
    THEN delete branch locally
    git branch -D <branch-name>
    to check the branch you’re currently on
    git rev-parse --abbrev-ref HEAD

Rules of Contributing and Any Considerations or How and What to Contribute

  • Follow the git workflow above.
  • Use GitHub Issues to view and assign work.
  • Follow the Agile & Scrum methodology.

Setting up the local development environment

Prerequisites

Installation

  1. Clone the project repository to your local machine using Git.
git clone https://github.com/agiledev-students-spring-2023/final-project-driply.git
  1. Navigate to the project directory using the terminal.
cd final_project_driply
  1. Install the dependencies required for the project using npm, as seen in the steps below in "Building the Project"

Building the Project

Build and launch the front end

  1. Run cd front-end to navigate into the front-end directory
  2. Run npm install to install all dependencies listed in the package.json file.
  3. Run npm start to launch the React.js server

Build and launch the back end

  1. Run cd back-end to navigate into the back-end directory
  2. Run npm install to install all dependencies listed in the package.json file.
  3. Run npm start to launch the back-end server

Testing the Project

Before contributing any changes, it's essential to make sure that the project runs without any issues. The project should pass all the unit and integration tests before merging the changes into the main branch.

To run the tests, follow the steps below:

  1. Navigate into the back-end directory
  2. Run npm test to execute the test cases

It's crucial to ensure that all tests pass before submitting any changes. If there are any test failures, fix the issues before submitting the changes.

Additionally, you can test the project manually by running it on your local machine and verifying that all the features and functionalities work as expected.