[LTER / IM] Write DataBits Article about Conventional Commits

lter / scicomp

LTER Scientific Computing ("SciComp") team website

https://lter.github.io/scicomp/

Creative Commons Zero v1.0 Universal

2 stars 0 forks source link

[LTER / IM] Write DataBits Article about Conventional Commits #7

Open njlyon0 opened 2 months ago

njlyon0 commented 2 months ago

Summary

Stevan Earl let me know about "Conventional Commits" and I've loved it as a scaffold for improving my own Git commit strategy. Marty suggested that I could write a short DataBits article about this to help spread the good news and that seems like a great idea

Starting Tasks

[x] Invite Stevan to collaborate on the article
[x] Draft structure of article
- [x] Workshop with Stevan
[x] Flesh outline out into full draft
- [x] Revise with Stevan
[x] Submit article to Marina Frants (mfrants [at] ucsd.edu)
- [ ] Revise with Marina
- [ ] Revise with Gabe de la Rosa (final reviewer)

Useful links

Article draft Google Doc
Conventional Commits' own documentation
Nick's Conventional Commit summary page

njlyon0 commented 2 months ago

Sitrep

I migrated this from GitHub Enterprise so need to give some quick updates on how we got to where we are. Stevan is interested in co-authoring this article with me so we've begun work on a big-picture outline together which can inform the full text of the article as we develop it.

njlyon0 commented 1 month ago

First Draft (Mostly) Complete

Just finished most of the first draft of the article. Definitely a little rough around the edges but it's something to revise from at the least so not a total loss. Also need to work in some example GitHub repositories that use this approach to demonstrate the benefits. Also need to integrate some conversation about GitHub issues so that I can segue from that into the repo Stevan shared with me that uses issue numbers in commit messages so that they explicitly link together tasks and commits

njlyon0 commented 1 month ago

Stevan Reviewing

Stevan saw my activity in the doc and reached out to let me know he'll review/revise the draft text this week or next! Moving this issue to pending on my end so that I don't step on his toes during that process

njlyon0 commented 2 weeks ago

Submitted!

Got Angel to review (thanks Angel!) and after that Stevan and I agreed it was submission-ready. Went ahead and emailed Marina with the article GoogleDoc so we'll see what she has to say / what the next steps of submission process look like.

njlyon0 commented 1 week ago

Marina Reviewing

Marina is looking at the draft and has promised to look it over by the end of this week. Hope it goes smoothly! 🤞