RecipEase

A web app intended to focus users on sufficiently fueling their bodies with the proper nutrients each day.

Flex Goal: Allow users to simplify the creation of grocery lists by saving recipes entered by users and creating a grocery list based on ingredients and serving amounts

Styling
Git Workflow
Requirements
Development

✏️ Styling

Note: This repo requires that you use the styling outlined in the following guide: AirBnb Style Guide

💻 How can I contribute?

Start with the dev branch

All feature branches are created off the latest code state of a project. This guide assumes this is maintained and updated in the dev branch.

git checkout dev
git fetch origin
git reset --hard origin/main

This switches the repo to the dev branch, pulls the latest commits and resets the repo's local copy of dev to match the latest version.

Create a new-branch

Use a separate branch for each feature or issue you work on. After creating a branch, check it out locally so that any changes you make will be on that branch.

git checkout -b new-feature

This checks out a branch called new-feature based on dev, and the -b flag tells Git to create the branch if it doesn’t already exist.

Update, add, commit, and push changes

On this branch, edit, stage, and commit changes in the usual fashion, building up the feature with as many commits as necessary. Work on the feature and make commits like you would any time you use Git. When ready, push your commits, updating the feature branch on Github.

git status
git add <some-file>
git commit

Push feature branch to remote

It’s a good idea to push the feature branch up to the central repository. This serves as a convenient backup, when collaborating with other developers, this would give them access to view commits to the new branch.

git push -u origin new-feature

Submitting Features

To avoid breaking merge conflicts all feature branches must be merged into an updated copy of the 'dev' branch on your local machine prior to submitting a pull request to merge a new feature branch into the dev branch.

git checkout dev
git pull origin
git checkout new-feature
git merge dev

Once you handle any merge conflicts or issues with your feature code and the potential changes made to the dev branch, you can commit your code and push to Github where you will open a pull request against the dev branch. After code review, if your code is approved, your feature branch will be merged into the dev branch.

Code Reviews

All code submitted to this repo will require a code review prior to being merged and final approval authority/merging pull requests will be the responsibility of the branch's code owner. In the event of code being merged without proper approval, the repo will be subject to rollback and the code removed.

Additional workflow information can be found here: Git Feature Branch Workflow