From 32c1c582d2077ec7b79ffc82fe12dbe0ee93291f Mon Sep 17 00:00:00 2001 From: dgonzdev Date: Sat, 14 Feb 2026 07:49:56 -0500 Subject: [PATCH 1/2] add contributing documentation --- README.md | 8 +++++++- docs/CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 docs/CONTRIBUTING.md diff --git a/README.md b/README.md index 3069cd0..147c910 100644 --- a/README.md +++ b/README.md @@ -61,4 +61,10 @@ More platforms coming soon. ## Contributing -TODO \ No newline at end of file +TLDR: +- Fork the repository +- Create a branch +- Make your changes +- Submit a pull request + +The [contributing document](docs/CONTRIBUTING.md) explains more. \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..fc7d414 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing + +## TLDR + +- Fork the repository +- Create a branch +- Make your changes +- Submit a pull request + +## Adding New Datasets + +- Create a new table in the primary database + - Table name should match the dataset's official name +- Create a rails model for the table + - Model should be namespaced under the department that publishes the dataset + - Model should set self.table_name to the dataset's official name +- Add the following API endpoint constants: + - SODA2_API_ENDPOINT + - SODA2_CSV_API_ENDPOINT + - SODA3_API_ENDPOINT + - SODA3_CSV_API_ENDPOINT +- Add the following metadata class methods: + - url + - name + - description + - data_provided_by + - agency + - update_frequency + - automation + - date_made_public + - category + - tags +- Add the public class import method and the following private class methods + - import_soda2 + - import_soda2_csv + - import_soda3 + - import_soda3_csv From 194f5d921847e422335cd4b41795334b25fb46e3 Mon Sep 17 00:00:00 2001 From: dgonzdev Date: Sat, 14 Feb 2026 07:54:00 -0500 Subject: [PATCH 2/2] add contributing documentation --- README.md | 2 +- docs/CONTRIBUTING.md | 15 ++++++++++----- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 147c910..79c00fb 100644 --- a/README.md +++ b/README.md @@ -67,4 +67,4 @@ TLDR: - Make your changes - Submit a pull request -The [contributing document](docs/CONTRIBUTING.md) explains more. \ No newline at end of file +The [contributing document](docs/CONTRIBUTING.md) provides more information. \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index fc7d414..162852c 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -30,8 +30,13 @@ - date_made_public - category - tags -- Add the public class import method and the following private class methods - - import_soda2 - - import_soda2_csv - - import_soda3 - - import_soda3_csv +- Add the following import class methods: + - import (public) + - import_soda2 (private) + - import_soda2_csv (private) + - import_soda3 (private) + - import_soda3_csv (private) + +## Adding New ETL Workflows + +TODO \ No newline at end of file