FDS

Build files

The source code in this repository (located in /src) needs to be compiled to ES2015 JavaScript (located in /lib).

This is done by running $ npm run build for a single build or you can $ npm run start to build once and watch for changes and rebuild those as soon as they occur.

The built files are checked in to git.

Git hooks

When committing on the 'develop' branch of this repository. A number of scripts run first to ensure the code is formatted consistently (using prettier and eslint), passes all tests (using jest) and all source files are built. These scripts and git hooks are installed automatically during postinstall (for more info, see husky).

These checks only run on the 'develop' branch, so you can still iterate and experiment quickly on feature branches.

Merging

In order to minimize the effort of handling merge conflicts, the files in the /lib folder should be ignored for diffing and merging. To accomplish this, the /.gitattributes file tells git to not use the diff program for anything inside the /lib folder and to use a custom merge driver for them as well.

This merge driver needs to be defined in your local /.git/config file. This is done automatically by a postinstall script, see package.json and the /scripts folder for more details.

Steps for merging a feature branch onto develop (with a PR)

Always make sure you have the latest origin/develop branch checked out locally.
$ git checkout develop
$ git pull -r

To ensure rebase conflicts only need to be solved once

Squash your feature branch into a single commit.
$ git checkout YOUR_BRANCH
$ git merge-base HEAD develop
Copy the commit hash outputted by the command above.
$ git reset --soft COMMIT_HASH
(Optionally) Push the single commit feature branch to bitbucket.
$ git push -f

1. Rebase your single commit feature branch on origin/develop.
   $ git rebase origin/develop
   Fix any conflicts
   $ git mergetool
2. Build all source files manually after the rebase is complete and all conflicts have been fixed.
   $ npm run build
3. Add any newly built files to the previous single commit on your feature branch.
   $ git add .
$ git commit --amend --no-edit
4. Push the rebased feature branch to bitbucket so it can keep track of the merge.
   $ git push -f
5. Merge the rebased feature branch on develop.
   $ git checkout develop
$ git merge YOUR_BRANCH
6. Push the new commit on origin/develop (this will let bitbucket know the merge is done).
   $ git push