Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.59 KB

Contributing

First of all, read the code of conduct for this project. Then, follow the instructions in the README to get everything installed.

Git

Committing

We (try to) use the Feature Branch Workflow, so don't push to the master branch unless you know what you're doing.

Do your best to use descriptive branch names, but more importantly, use good commit messages! Here's a good post to write about commit messages.

Large Files

We use Git LFS to store larger files. If you want to see those larger files (videos, presentations, etc.) make sure to install it. Once you have it installed, you can use Git as you usually would.

For files tracked using Git LFS, note that any changes will result in the whole file being re-uploaded. So ask before you start tracking any huge files that will need to be changed.

If you need to commit a video, try to compress it first. For mostly static videos (like of droplets) try this:

ffmpeg -i input.mp4 -vcodec libx264 -crf 28 output.mp4

A higher crf will be more compressed.

Code Style

Please watch your trailing whitespace! There should basically be no whitespace at the end of any lines. Look up how to configure your editor to automatically do this, and you'll make the world a better place.

Aside from that, for Rust, cargo fmt will take care of most things.