Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 4.11 KB

README.md

File metadata and controls

65 lines (39 loc) · 4.11 KB
Raw

hlp2020-team-n

Sample repo for HLP2020.

FOLLOW THESE INSTRUCTIONS

They let you use gitub with a private repo and more than 3 contributors

(1) Create a github id from github.com using your imperial.ac.uk e-mail address if you don't have such now.

(2) Join ImperialCollegeLondon organisation as detailed here. NB you must be on campus or vpn for this to work.

(3) Create a github private repo named hlp2020-id under imperialcollege london org where id is replaced by your piazza team id (spaces turned into -).

(4) Clone it locally

(5) Download this repo as a zip file

(5) extract all files from zip into local clone previously created

  • check this readme is at top level in repo clone
  • check ./.gitignore exists in repo clone

(6) Add all team members as contributors with write permission.

(6a) Add me as contributor with read permission.

(7) Each team member clone the repo to their own computers.

Working with the team repo

The directory tomcl shows sample individual code submission files and project.

  • Add one directory for each team member named by his/her IC login
  • Create branches for each team member (see below). After initial setup no-one should directly commit to master except for repo maintenance purposes.
  • Make sure the project and file structure for each individual submission follows that in tomcl directory (module files can have different names, there can be more than one module)
  • Each team member must KEEP ALL THEIR INDIVIDUAL CODE UNDER THEIR DIRECTORY EXCEPT FOR FUNCTIONS WRITTEN FOR OTHER PEOPLE
  • Each team member should do work under OWN BRANCH(s). OWN branches named login-XXX where login is team member login and XXX is name of branch. (Could be just one branch named login-dev).
  • Each team member should merge their work to master/ update from master from time to time. Needed before end (for assessment) and if their work has functions contributed from/to others.
  • Directory team will be used for final team deliverable. In that case merging individual branch work is not trivial since all code will run under the same directory.

FSharp files and modules

One module per file, module name same as file name. Module names should be capitalised.

Sharing Code & Types

Shared types: genuinely shared, developed at start, can be put into a common types module under libs subdirectory (not owned by any one person). Or, if you prefer, it can be owned for assessment purposes by one person and put under their code.

Shared library code can be developed by an individuals as a module under their personal directory (for assessment of indiv code) and shared by others since you can add a module with source file anywhere to your fsharp project.

Obviously to share your code you will need to make sure it gets merged from your dev branch into master.

During team phase, to make modules neater, you can relaocate shared library modules to a separate libs directory etc.

eeextensions.fs is a shared library I give you with a few utility functions added to the core standard libraries. Put this under your repo libs directory from the start, and use it (from there) if you need to.

Guidelines

  • Always do development on own branch, never directly on master
  • Commit to own branch regularly - at least once per hour of work
  • Fetch/Push local clone to github cloud regularly (gives you backup in case of computer breakdown/loss/left it in wrong place)
  • Create pull request to master and then Merge pull request when own branch code reaches consistent state of when needed to share code with other team members (e.g. if they are writing functions in your module)
  • Update own branch from master regularly. Normally in individual phase this will have no great effect (because it will only change code in other team member's directories).
  • NEVER COMMIT CODE EXCEPT TO OWN BRANCH (even when writing functions from someone else, good practice is go through merge onto master, then they update from master)