add a release process, and add a list of the tools i use when developing.

This commit is contained in:
Julia Longtin 2019-05-11 12:51:12 +01:00
parent 17cd487565
commit afcee1b594
2 changed files with 50 additions and 0 deletions

34
Release.md Normal file
View File

@ -0,0 +1,34 @@
# Release Processes:
Purpose of this document: to make sure i follow a consistent patern, when making changes to ImplicitCAD.
## "no point" releases:
### Comment / Format / Messages
These changes don't improve anything but the code quality, messages output, or build system. they can add features to the parser, but cannot remove them. they may not change the md5 of the generated STL files.
1. make sure test-implicit is all green.
2. make sure parser-bench hasn't gone all out of control.
3. make sure docgen hasn't changed it's output too much.
push to master.
### Math / Types
These releases change the math engine, but only in a direction that is provably better, and shows in our examples.
1. do all of the above.
2. check 'make examples' output. look at the times that valgrind measures.
3. check the md5sum of the .stl files output.
If the md5sums of the last release and this one differ, run admesh on both, and examine the output. if the output is conclusively better for all changed examples, then proceed to push.
push to master.
## point releases:
These releases change the quality of the output significantly enough that poking it with admesh is indeterminate, or they include changes to the parser such that old code would not work.
## major releases:

16
Tools.md Normal file
View File

@ -0,0 +1,16 @@
# Purpose of this document:
List the external tools i've found useful with this codebase.
# Tools:
## Workflow:
My workflow consists of:
### admesh
### meshlab
## Code Checking
'weeder' is useful.