Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion .github/workflows/ci-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -78,3 +78,21 @@ 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 pylint
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
31 changes: 15 additions & 16 deletions collaboration/communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,19 @@

## 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
Expand All @@ -37,18 +36,18 @@ how often will we get in touch on each channel, and what we will discuss there:

### 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 youve 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. _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
4 changes: 4 additions & 0 deletions collaboration/guide/0_repository_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
3 changes: 3 additions & 0 deletions collaboration/retrospectives/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Retrospectives

Retrospective documents for each milestone of the CDSP.
36 changes: 28 additions & 8 deletions guide.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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,
Expand Down
Loading