Skip to content

Instantly share code, notes, and snippets.

View jcornaz's full-sized avatar

Jonathan Cornaz jcornaz

View GitHub Profile
@jxson
jxson / README.md
Created February 10, 2012 00:18
README.md template

Synopsis

At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

Code Example

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

Motivation

@pbrisbin
pbrisbin / semver-pvp.md
Created February 16, 2018 00:31
Versioning Haskell: Semver <> PVP

I personally prefer [Semver][]. I think it's reasonable, simple, and makes sense. But as a good Haskell citizen, I'd like to be [PVP][]-compliant as well. Here is a bit of a graphic showing how the two systems are almost the same:

PVP:            A . B     . C     . ...
Semver:             Major . Minor . Patch
                    ^       ^       ^
                    |       |       |
                    |       |       ` increment for other changes
                    |       |
                    |       ` increment on non-breaking change
@pbrisbin
pbrisbin / example.md
Last active April 23, 2020 10:54 — forked from ericclemmons/example.md
HTML5 <details> in GitHub

Using <details> in GitHub

Suppose you're opening an issue and there's a lot noisey logs that may be useful.

Rather than wrecking readability, wrap it in a <details> tag!

<details>
 <summary>Summary Goes Here</summary>
@jakobhellermann
jakobhellermann / update-bevy-0.5.sh
Last active March 23, 2021 15:10
Does the easily automatable part of updating bevy 0.5
#!/bin/bash
if [[ $(git diff --stat) != '' ]]; then
echo 'git has uncommit changes, please commit as this tool can break stuff'
exit
fi
echo "warning: this code isn't very well tested"
read -p "Press enter to continue: "