From 232b172cf0e6f938d7486458b7e4855612c18557 Mon Sep 17 00:00:00 2001 From: Kanit Wongsuphasawat Date: Thu, 17 May 2018 18:13:15 -0700 Subject: [PATCH] Add notes about building examples --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65f0c52780..e73836973e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,7 +75,9 @@ To name the example file: After building an updated code or add a new example, make sure to run `yarn build:example ` (e.g., `yarn build:example bar_1d`) or `yarn build:examples` to recompile all examples so that your pull request includes a new compiled Vega specs and SVG files in `examples/compiled`. -__Note:__ To run `yarn build:examples`, you need to install [gnu parallel](https://www.gnu.org/software/parallel/). (For Mac, you can simply do `brew install parallel`.) +__Notes:__ +1) Our example building scripts only re-compile SVGs if the output Vega file changes (so it runs way faster). However, if you have a bug and accidentally change Vega outputs, please do not commit SVGs after you fix the bugs (as the SVGs are **not** recompiled if Vega output do not change from prior commits). Instead, please reset your SVG changes. +2) To run `yarn build:examples`, you need to install [gnu parallel](https://www.gnu.org/software/parallel/). (For Mac, you can simply do `brew install parallel`.) # Development Guide