Diagrams/Dev

Guidelines

• How to contribute

• Coding style guidelines. It's not worth being super picky about these, but in general they are quite good.

• git commit message guidelines.

• Guidelines for reviewing and merging code. For those with push access to one or more repos in the github diagrams organization.

Design notes

• Text support
• Notes on extending support for paths
• Bounding functions
• Notes on the representation of transformations: linear and affine transformations, inverse, transpose, etc.
• Arrows
• Gradients
• Backend type parameters and the expression problem
• Fixpoint semantics
• Constraint design notes
• Aligned composition

Outdated design notes

Stuff which is no longer current but kept here for historical reference.

• Freeze, attribute transformation, and the backend API (after the merging of the "units" branch, freeze is no more)

Links/resources

Links to software, papers, documentation, etc. which is helpful or relevant.

• cairo reference manual

• potrace, a nice raster -> vector library. Even has a detailed description of the algorithms used.
• A Library for Declarative Resolution-Independent 2D Graphics (PADL 2013)
• Pan (Conal Elliott)

Misc instructions

• How to add IRC Hooks to repositories in the github diagrams organization

Releases

• 0.5 to 0.6 migration
• 0.6 to 0.7 migration
• 0.7 to 1.0 migration
• 1.0 to 1.1 migration
• 1.0 to 1.1 migration
• 1.1 to 1.2 migration
• 1.2 to 1.3 migration
• 1.3 to 1.4 migration

Miscellaneous links

• [1]: ticket re: GHC error messages with ambiguous type variables. This comes up a lot when using diagrams, it would be nice to see this ticket resolved.

• travis-ci build status of all diagrams packages.

• byorgey's time spent hacking on diagrams:

• Notes on automating tedious parts of our release process