Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Co-authored-by: Thomas Yu <[email protected]>
  • Loading branch information
BWMac and thomasyu888 authored Nov 15, 2023
1 parent 2be7e60 commit 4fb2e45
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ This package uses [Great Expectations](https://greatexpectations.io/) to validat
1. Create a new expectation suite by defining the expectations for the new dataset in a Jupyter Notebook inside the `gx_suite_definitions` folder. Use `metabolomics.ipynb` as an example.
1. Run the notebook to generate the new expectation suite. It should populate as a JSON file in the `great_expectations/expectations` folder.
1. Add support for running Great Expectations on a dataset by adding the `gx_folder` key to the configuration for your datatset in both `test_config.yaml` and `config.yaml`. The `gx_folder` should be a Synapse ID pointing to the folder where we will upload generated HTML reports from Great Expectations. If a folder specific to your dataset does not yet exist in the proper locations ([Prod](https://www.synapse.org/#!Synapse:syn52948668), [Testing](https://www.synapse.org/#!Synapse:syn52948670)), create folders named after the dataset and copy the new folders' Synapse IDs to the config files.
1. Add support for running Great Expectations on a dataset by adding the `gx_folder` key to the configuration for your datatset in both `test_config.yaml` and `config.yaml`. The `gx_folder` should be a Synapse ID pointing to the folder where we will upload generated HTML reports from Great Expectations. If a folder specific to your dataset does not yet exist in the proper locations ([Prod](https://www.synapse.org/#!Synapse:syn52948668), [Testing](https://www.synapse.org/#!Synapse:syn52948670)), create folders named after the dataset and copy the new folders' Synapse IDs to the config files.
1. Test data processing by running `adt test_config.yaml` and ensure that HTML reports with all expectations are generated and uploaded to the proper folder in Synapse.

#### Custom Expectations
Expand Down

0 comments on commit 4fb2e45

Please sign in to comment.