From 94405ffee3c86b5303b148f821d3c2b1c23f129e Mon Sep 17 00:00:00 2001 From: likechrisss Date: Mon, 2 Jun 2025 09:56:24 -0400 Subject: [PATCH 1/8] fix(md): correct formatting in 1_datasets/guide.md to satisfy md_lint rules --- 1_datasets/guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/1_datasets/guide.md b/1_datasets/guide.md index eadf53553..8b1787614 100644 --- a/1_datasets/guide.md +++ b/1_datasets/guide.md @@ -43,6 +43,8 @@ Below is an overview of different kinds of dataset you will encounter: 6. [Classification by Purpose](#classification-by-purpose) 7. [Classification by Format](#classification-by-format) +## Classification by Data Type + ### Quantitative (Numerical) Data Data that represents quantities and can represented as numbers. From d73a824ee6fc00d2a7d4fc11de89d11ccdbc9024 Mon Sep 17 00:00:00 2001 From: likechrisss Date: Mon, 2 Jun 2025 10:06:23 -0400 Subject: [PATCH 2/8] additional fixes in collaboration_communication --- collaboration/communication.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/collaboration/communication.md b/collaboration/communication.md index bdf6d3730..c45856000 100644 --- a/collaboration/communication.md +++ b/collaboration/communication.md @@ -31,9 +31,9 @@ how often will we get in touch on each channel, and what we will discuss there: ### Availability for calling/messaging -| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | | -| ------ | :----: | :-----: | :-------: | :------: | :----: | :------: | :----: | --- | -| _name_ | | | | | | | | +| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday| +| ------ | :----: | :-----: | :-------: | :------: | :----: | :------: | :----:| +| _name_ | | | | | | | | ### How many hours everyone has per day @@ -51,4 +51,4 @@ based on how long you've been stuck on the same problem: 1. _0 -> 30 min_: Try on your own 1. _30 -> 60 min_: Ask your group for help -1. _60+ min_: Tag your coaches in Slack or GitHub +1. _60+ min_: Tag your coaches in Slack, Whatsapp or GitHub From f6807b9f56b83e5ce624b925ba5dc865e22207d9 Mon Sep 17 00:00:00 2001 From: likechrisss Date: Mon, 2 Jun 2025 10:14:33 -0400 Subject: [PATCH 3/8] Fixed more issues in guide.md --- collaboration/communication.md | 37 ++++++++++++++++----------------- guide.md | 38 ++++++++++++++++++++++++++-------- 2 files changed, 47 insertions(+), 28 deletions(-) diff --git a/collaboration/communication.md b/collaboration/communication.md index c45856000..c40ddcfdf 100644 --- a/collaboration/communication.md +++ b/collaboration/communication.md @@ -13,42 +13,41 @@ ## Communication Schedule -| Day | How | The topic of discussion | | --- | :-: | ----------------------- | -| | | | +| Day | How | The topic of discussion | +| :----: | :-: | ----------------------: | +| | | | ## Communication Channels -how often will we get in touch on each channel, and what we will discuss there: +How often we will get in touch on each channel, and what we will discuss there: - **Issues**: - **Pull Requests**: - **Slack/Discord**: - **Video Calls**: ---- - ## Availability ### Availability for calling/messaging -| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday| -| ------ | :----: | :-----: | :-------: | :------: | :----: | :------: | :----:| -| _name_ | | | | | | | | +| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | +| :----: | :----: | :-----: | :-------: | :------: | :----: | :------: | :----: | +| _name_ | | | | | | | | ### How many hours everyone has per day -- name: _5h_; -- name: _6h_; -- name: _5h_; -- name: _4h_; -- name: _3h_; +- name: _5h_ +- name: _6h_ +- name: _5h_ +- name: _4h_ +- name: _3h_ ## Asking for Help -There's a fine line between confidently learning from your mistakes, and -stubbornly getting no where. Here is a general guide for when to ask for help -based on how long you've been stuck on the same problem: +There's a fine line between confidently learning from your mistakes and +stubbornly getting nowhere. Here is a general guide for when to ask for help +based on how long you’ve been stuck on the same problem: -1. _0 -> 30 min_: Try on your own -1. _30 -> 60 min_: Ask your group for help -1. _60+ min_: Tag your coaches in Slack, Whatsapp or GitHub +1. _0 → 30 min_: Try on your own +2. _30 → 60 min_: Ask your group for help +3. _60+ min_: Tag your coaches in Slack, WhatsApp or GitHub diff --git a/guide.md b/guide.md index 75029ea6a..905ae0462 100644 --- a/guide.md +++ b/guide.md @@ -1,16 +1,35 @@ -# ET6 CDSP Starter: Guide +# ET6 CDSP Starter -This repository is here to help guide you through the -[Collaborative Data Science Project (CDSP)](https://docs.google.com/document/d/1TaoVVqJD5EqmBGLw6_qzph8EZnuL6uhY/edit?usp=sharing&ouid=100638458423869369523&rtpof=true&sd=true). +This repository provides a template and guidelines for the +**Emerging Talent 6 Collaborative Data Science Project (CDSP)**. It is +designed to support a reproducible workflow so that anyone can clone, +run, and verify your analysis from start to finish. -This repository's structure roughly follows the CDSP milestones. It's also -designed to help you do **reproducible** research. If your research process is -well organized, others should be able to clone it, run all scripts (without -errors!), and evaluate your conclusions for themselves. +--- -``` +## Project Overview + +The CDSP is a six‐milestone initiative where teams work together to +identify a research question, collect and analyze data, and communicate +findings. This repository’s structure follows those milestones and +encourages best practices in collaboration, version control, and +documentation. + +Use this template to: + +- Organize your files and code in a clear, consistent folder structure +- Maintain reproducibility so others can run your pipeline without issues +- Document team norms, communication plans, and milestone retrospectives +- Track tasks, issues, and pull requests through GitHub’s project boards + +--- + +## Directory Structure + +```text / -├── README.md # Project overview and main findings +├── README.md # Project overview and main instructions +├── guide.md # Detailed guide on using this template ├── /collaboration/ # Team norms, strategies, and retrospectives ├── /notes/ # Shared resources and learning materials ├── /0_domain_study/ # Domain research and background @@ -20,6 +39,7 @@ errors!), and evaluate your conclusions for themselves. ├── /4_data_analysis/ # Scripts for in-depth analysis ├── /5_communication_strategy/ # Materials for communicating findings └── /6_final_presentation/ # Final presentation materials + ``` Below are some suggestions on how to use the folders/files in this repository, From faba0b3c80a41aee48ce47870f9c3ea9af598093 Mon Sep 17 00:00:00 2001 From: Evan Cole <18554853+colevandersWands@users.noreply.github.com> Date: Mon, 2 Jun 2025 16:11:34 -0400 Subject: [PATCH 4/8] update pylint command from foundations directories to all .py --- .github/workflows/ci-checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-checks.yml b/.github/workflows/ci-checks.yml index fdf9eb06f..a2eee96f6 100644 --- a/.github/workflows/ci-checks.yml +++ b/.github/workflows/ci-checks.yml @@ -48,7 +48,7 @@ jobs: pip install pylint shell: bash - name: Python - Check Linting - pylint - run: "pylint solutions tests || echo '::warning title=Pylint Error(s)::Discuss solutions and trade-offs in code review.'" + run: "pylint **/*.py --ignore-paths=env,venv,.env,.venv,__pycache__,.git || echo '::warning title=Pylint Error(s)::Discuss solutions and trade-offs in code review.'" shell: bash py_tests: From de34fff1cc3d63c77e2f87fb718b71cebc163efb Mon Sep 17 00:00:00 2001 From: colevandersWands <18554853+colevandersWands@users.noreply.github.com> Date: Mon, 2 Jun 2025 16:17:46 -0400 Subject: [PATCH 5/8] linting for python notebooks (experimental) --- .github/workflows/ci-checks.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/.github/workflows/ci-checks.yml b/.github/workflows/ci-checks.yml index fdf9eb06f..da3b30f81 100644 --- a/.github/workflows/ci-checks.yml +++ b/.github/workflows/ci-checks.yml @@ -78,3 +78,20 @@ jobs: if: steps.check_tests.outputs.has_tests == 'true' run: python -m unittest shell: bash + + py_notebook_linting: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: python version + run: python --version + shell: bash + if: always() + - name: install nbqa + run: | + python - m pip install --upgrade pip + pip install nbqa + shell: bash + - name: Python Notebooks - Check Linting - nbqa + run: "nbqa pylint *.ipynb || echo '::warning title=NoteBook QA Error(s)::Discuss solutions and trade-offs in code review.'" + shell: bash From f98a1687844c0a29d8d812079c65cc895b6251c7 Mon Sep 17 00:00:00 2001 From: colevandersWands <18554853+colevandersWands@users.noreply.github.com> Date: Mon, 2 Jun 2025 16:19:12 -0400 Subject: [PATCH 6/8] first install pylint --- .github/workflows/ci-checks.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci-checks.yml b/.github/workflows/ci-checks.yml index d4e66fd62..488e98dca 100644 --- a/.github/workflows/ci-checks.yml +++ b/.github/workflows/ci-checks.yml @@ -90,6 +90,7 @@ jobs: - name: install nbqa run: | python - m pip install --upgrade pip + pip install pylint pip install nbqa shell: bash - name: Python Notebooks - Check Linting - nbqa From 85dedf573d0e55f8daa58749e2f1ae7d556a9764 Mon Sep 17 00:00:00 2001 From: KarimMakki Date: Tue, 3 Jun 2025 04:57:01 +0800 Subject: [PATCH 7/8] add note to enable CI checks in repository setup guide --- collaboration/guide/0_repository_setup.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/collaboration/guide/0_repository_setup.md b/collaboration/guide/0_repository_setup.md index aae9cb76e..444bcc7c5 100644 --- a/collaboration/guide/0_repository_setup.md +++ b/collaboration/guide/0_repository_setup.md @@ -20,6 +20,10 @@ it for collaboration: - _Issues_ - _Projects_ - _Always suggest updating pull request branches_ +- Enable CI Checks + - Under the _Actions_ tab: + - Enable workflows to ensure CI checks run on all pushes and pull requests. + _(Note: If workflows are disabled, CI checks won’t trigger until enabled.)_ - Collaboration Settings - Require a code review for PRs to `main`/`master` ([owanateamachree](https://owanateamachree.medium.com/how-to-protect-the-master-branch-on-github-ab85e9b6b03), From e7f31b20f2a2cd897e54340acdcd3ba9a9b5c0dc Mon Sep 17 00:00:00 2001 From: colevandersWands <18554853+colevandersWands@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:01:56 -0400 Subject: [PATCH 8/8] templating for milestone retrospectives --- collaboration/retrospectives/0_cross_cultural_collaboration.md | 0 collaboration/retrospectives/1_problem_identification.md | 0 collaboration/retrospectives/2_data_collection.md | 0 collaboration/retrospectives/3_data_analysis.md | 0 collaboration/retrospectives/4_communicating_results.md | 0 collaboration/retrospectives/5_final_presentation.md | 0 collaboration/retrospectives/README.md | 3 +++ .../{retrospective.md => retrospectives/_template.md} | 0 8 files changed, 3 insertions(+) create mode 100644 collaboration/retrospectives/0_cross_cultural_collaboration.md create mode 100644 collaboration/retrospectives/1_problem_identification.md create mode 100644 collaboration/retrospectives/2_data_collection.md create mode 100644 collaboration/retrospectives/3_data_analysis.md create mode 100644 collaboration/retrospectives/4_communicating_results.md create mode 100644 collaboration/retrospectives/5_final_presentation.md create mode 100644 collaboration/retrospectives/README.md rename collaboration/{retrospective.md => retrospectives/_template.md} (100%) diff --git a/collaboration/retrospectives/0_cross_cultural_collaboration.md b/collaboration/retrospectives/0_cross_cultural_collaboration.md new file mode 100644 index 000000000..e69de29bb diff --git a/collaboration/retrospectives/1_problem_identification.md b/collaboration/retrospectives/1_problem_identification.md new file mode 100644 index 000000000..e69de29bb diff --git a/collaboration/retrospectives/2_data_collection.md b/collaboration/retrospectives/2_data_collection.md new file mode 100644 index 000000000..e69de29bb diff --git a/collaboration/retrospectives/3_data_analysis.md b/collaboration/retrospectives/3_data_analysis.md new file mode 100644 index 000000000..e69de29bb diff --git a/collaboration/retrospectives/4_communicating_results.md b/collaboration/retrospectives/4_communicating_results.md new file mode 100644 index 000000000..e69de29bb diff --git a/collaboration/retrospectives/5_final_presentation.md b/collaboration/retrospectives/5_final_presentation.md new file mode 100644 index 000000000..e69de29bb diff --git a/collaboration/retrospectives/README.md b/collaboration/retrospectives/README.md new file mode 100644 index 000000000..08d9b0582 --- /dev/null +++ b/collaboration/retrospectives/README.md @@ -0,0 +1,3 @@ +# Retrospectives + +Retrospective documents for each milestone of the CDSP. diff --git a/collaboration/retrospective.md b/collaboration/retrospectives/_template.md similarity index 100% rename from collaboration/retrospective.md rename to collaboration/retrospectives/_template.md