Skip to content
This repository has been archived by the owner on Jan 7, 2019. It is now read-only.

Latest commit

 

History

History
28 lines (21 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.16 KB

Welcome!

To get started, it would be helpful to look at the GS1Combinators library.

The Database library we are using is Beam.

If you haven't already or if you are not comfortable with Beam, it might be worth completing the Beam tutorials, the first of which is here.

Our git workflow is branch-based (as opposed to being Fork based).

Naming git branches

Please make sure your git branches have a name relevant to the work you are doing in it suffixed by some form of identifier of your name (eg. your initials)

Making a branch is cheap (it is literally writing 40 characters to a file). Please make branches freely so long as they make the git workflow more understandable to everyone else in the team.

Modules of interest

The entire migration function lives in the module MigrateScript. This module is very tightly coupled with StorageBeam. So when you change something in the module StorageBeam, please make the equivalent change in the MigrateScript module as well.