Skip to content

milesapnash/Revzen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

176 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Group 28 DRP

Description

DRP group 28 featuring Nurdayana Muhd Faisal, Alfie Chenery, Miles Nash and Oliver Killane. Developing an app-based solution to prevent revision procrastination and study session distraction by mobile devices.

Milestone 1

Identified the problem, using both academic sources, our own survey and interviews to get an intuition for the problem, and how effective current solutions are.

The video presented can be found here.

Documentation:

The documentation for the backend is generated from the dev branch by our CI and can be found here.

Git Hygiene

Dev Branch

When making changes for new features, branch from, and eventually merge into the dev branch. Master is used for the public facing, released version. This allows for the group to test for bugs, use and experience new features, and show new feature developments to stakeholders before publicly releasing.

When merging into dev, deployment is done for our internal testing. Public deployment is done in master.

  1. Branch from dev
  2. Work in new branch
  3. Create merge request for the feature
  4. Get request reviewed, go through cycles of review & improvement.
  5. Merge into dev, can now use test deployment.
  6. dev pushed into Master.

Development Backend

Can be found here hosted on heroku.

Production Backend

Can be found here hosted on heroku.

Branch Names

Prefix/name-goes-here
Prefix Description
enh An enhancement, either a new feature, or improving an existing one. CI and test changes included. This should change both code behaviour and what behaviour we expect.
fix A bug fix to correct deviation of behaviour from expected.
doc Adding documentation, should not change any code behaviour! Comments only.
ref Refactoring of code, includes code changes but should not change behaviour.
any Anything not in the other categories.

Commits

Commits must have a descriptive name, and contain the shortcodes of those working on the commit.

In enh/show-users-online:

Added green dot to show online status in friends menu
[ ac320, ok220 ]

Merge Requests

  • All merge requests need to be reviewed by another team member.
  • Ideally before merging, the branch should be rebased against dev, though careful merging is fine.

For rebasing, simply go to the branch and use:

git rebase -i dev  # -i for interactive, and always against dev

Can then pick changes, save & add before using

git rebase --continue

Once the rebase is complete, a force push is required

git push --force

About

Imperial College London Year 2 Group Project: Procrastination prevention Android app designed as part of our Human Centered Development

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors