Imageomics / Imageomics/Collaborative-distributed-science-guide

Clarify commit suggestions

Open
#39 3 comments 0 reactions 0 assignees View on GitHub
design documentation help wanted question
Dominant language
Python
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

The [Formatting and Naming Conventions](https://imageomics.github.io/Collaborative-distributed-science-guide/wiki-guide/GitHub-Repo-Guide/#formatting-and-naming-conventions) section could use a re-visit. I think we need to elevate the commit portion, but also make it more in-line with practice. We should summarize the purpose of commit messages, highlighting important aspects of readability and understanding processes done. Then also link to good practices for, e.g., machine-readability and such, but the ultimate goal of understandable commits (why is this change happening) needs to be expressed clearly.

Contributor guide

Open the contributing guide

Research direction

Start with the linked Formatting and Naming Conventions section in the Collaborative Distributed Science Guide and review its current commit guidance. Done means the section clearly explains the purpose of commit messages, readability, and understanding the work performed, while linking to good machine-readable commit practices and emphasizing why changes happen.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.