Merge pull request #74 from staadecker/changelog

Add a change log for breaking changes

Author: pesap

REAM Model Changelog.md

@@ -0,0 +1,18 @@
+# REAM Model Breaking Changes
+
+This file specifies the breaking changes that we have done to the model.
+A breaking change is any change that would change the results of previously
+completed runs.
+
+## List of breaking changes to model
+
+Changes are listed from oldest (first line) to newest (last line of table).
+
+| PR | Month | Change description |
+| ---- | --- | ---------------------|
+| #12 | March 2021 | Use the middle of the period instead of the start as the cutoff for retirement and predetermined buildout. |
+| #15 | March 2021 | Fix bug where storage costs where being over-counted. |
+| #36 | May 2021 | Correct inputs to only list transmission lines in one direction. |
+| #56 | June 2021 | Convert 2020 predetermined build years to 2019 in `get_inputs.py` to avoid conflicts with 2020 period. |
+| #57 | June 2021 | Specify predetermined storage energy capacity in inputs (previously left unspecified). |
+| #68 | June 2021 | Change financial params to 2018 dollars & 5% interest rate. Start using terrain multipliers (which now include the economic multiplier). |

docs/Contribute.md

@@ -14,7 +14,9 @@ procedure.
 3. Once your changes are final and ready to be added to the switch main
 branch, create a pull request on Github.
 
-4. Get someone to review and then merge your changes on Github.
+4. If your change is a breaking change add it to `REAM Model Changelog.md`.
+   
+5. Get someone to review and then merge your changes on Github.
 
 For more information read [this excellent guide](https://guides.github.com/introduction/flow/) (5 min read).