From 4eeaccf3a7862acf1ffcb7c97275a2bd80361cdd Mon Sep 17 00:00:00 2001 From: Luna Bellec Date: Tue, 11 Feb 2025 16:29:12 -0500 Subject: [PATCH 1/3] Started drafting naming conventions. --- content/_toc.yml | 1 + content/project_organization.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 content/project_organization.md diff --git a/content/_toc.yml b/content/_toc.yml index 1261e19..7610058 100644 --- a/content/_toc.yml +++ b/content/_toc.yml @@ -9,3 +9,4 @@ chapters: - file: members - file: publications - file: contributing +- file: project_organization diff --git a/content/project_organization.md b/content/project_organization.md new file mode 100644 index 0000000..59c2984 --- /dev/null +++ b/content/project_organization.md @@ -0,0 +1,13 @@ +# Project organization + +## Components + * a slack channel, created using a project template + * project overview, with list of members and roles, as well as links to all the main elements (gdocs, github repos, website) + * task manager + * One github repo per component of the project + + +## Naming conventions + * slack: `project-` where name is all lower case, and can have subcomponents separated by hyphens that work well without hyphens. For example `project-mario-curiosity`, where `mariocuriosity` also works. + * github: `.`. Example `mario_curiosity.behavioural_analyses` (project name is similar to slack, but with `_` instead of `.`) + * Special cases: datasets. For datasets, `component` need to be a well documented processing pipeline designed to be reused. From 881f11fc2d2abee6d9cb434b1963a37d11f8cc8d Mon Sep 17 00:00:00 2001 From: Luna Bellec Date: Tue, 11 Feb 2025 16:37:32 -0500 Subject: [PATCH 2/3] WIP naming conventions. --- content/project_organization.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/project_organization.md b/content/project_organization.md index 59c2984..98d9e4d 100644 --- a/content/project_organization.md +++ b/content/project_organization.md @@ -9,5 +9,5 @@ ## Naming conventions * slack: `project-` where name is all lower case, and can have subcomponents separated by hyphens that work well without hyphens. For example `project-mario-curiosity`, where `mariocuriosity` also works. - * github: `.`. Example `mario_curiosity.behavioural_analyses` (project name is similar to slack, but with `_` instead of `.`) - * Special cases: datasets. For datasets, `component` need to be a well documented processing pipeline designed to be reused. + * github: `.`. Example `mario_curiosity.scene_agents` (project name is similar to slack, but with `_` instead of `.`) + * Special cases: datasets. For datasets, `component` need to be a well documented processing pipeline designed to be reused for anyone interested in the dataset. From 55821c81b2e4b851aae5b57ea4e589b8a67129e1 Mon Sep 17 00:00:00 2001 From: Luna Bellec Date: Tue, 11 Feb 2025 18:44:25 -0500 Subject: [PATCH 3/3] Rewording for better clarity using chatgpt o3-mini-high --- content/project_organization.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/content/project_organization.md b/content/project_organization.md index 98d9e4d..17b2322 100644 --- a/content/project_organization.md +++ b/content/project_organization.md @@ -1,13 +1,27 @@ -# Project organization +# Project Organization ## Components - * a slack channel, created using a project template - * project overview, with list of members and roles, as well as links to all the main elements (gdocs, github repos, website) - * task manager - * One github repo per component of the project +- **Slack Channel** + Each project must have a dedicated Slack channel, created using a standardized project template. This channel should include: + - **Project Overview:** A summary listing team members, their roles, and links to all key resources (e.g., Google Docs, GitHub repositories, project website). + - **Task Manager:** A dedicated space for tracking project tasks and deadlines. +- **GitHub Repositories** + Every distinct project component should be housed in its own GitHub repository. This modular structure promotes clarity and simplifies collaboration. -## Naming conventions - * slack: `project-` where name is all lower case, and can have subcomponents separated by hyphens that work well without hyphens. For example `project-mario-curiosity`, where `mariocuriosity` also works. - * github: `.`. Example `mario_curiosity.scene_agents` (project name is similar to slack, but with `_` instead of `.`) - * Special cases: datasets. For datasets, `component` need to be a well documented processing pipeline designed to be reused for anyone interested in the dataset. +## Naming Conventions +- **Slack Channel:** + Adopt the format `project-`, where `` is entirely in lowercase and may include subcomponents separated by hyphens. + *Example:* `project-mario-curiosity`. + +- **GitHub Repositories:** + Use the format `.`, with underscores permitted in both parts. + *Example:* `mario_curiosity.scene_agents`. + *Note:* Although the Slack channel uses hyphens, the GitHub naming convention favors underscores for readability and consistency. + +- **Special Cases – Github repositories for Reusable Datasets:** + For datasets intended for community sharing (e.g., datasets collected by CNeuroMod): + - The `` should correspond to the dataset’s name. + - The `` should describe a well-documented processing pipeline designed for reuse. + + Conversely, datasets generated specifically for a single project—without broader community reuse—should be managed as standard project components under the primary ``.