Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (31 loc) · 1022 Bytes

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1022 Bytes

Contributing

Prerequisites

This repo using git hooks to ensure that the code is committed in a good state. To install the hooks, run the following command:

git config core.hooksPath .githooks

Ensure the following are installed:

Documentation

Documentation is a vital part of Parley and should always be included for any change in functionality.

Via gifs

We are big fans of using gifs to demonstrate functionality. The easiest way to do this is via the following tools:

Given an input mp4 recording of some functionality, generate a gif as follows:

Set file variables:

export INPUT_MP4=input.mp4
export OUTPUT_GIF=output.gif

Convert mp4 to gif:

ffmpeg \
  -ss 0 \
  -i $INPUT_MP4 \
  -vf "fps=10,scale=1080:-1:flags=lanczos,split[s0][s1];[s0]palettegen[p];[s1][p]paletteuse" \
  -loop 0 -f gif - | gifsicle --optimize=3 --delay=5 > $OUTPUT_GIF