Skip to content

Conversation

@egrace479
Copy link
Member

As this template is updated, we pull new material into both the Imageomics and ABC Guides. Anyone else using this template may also wish to pull updates. Other than the documentation, there's not much for available guidance on cherry picking commits, so this PR adds a git cherry-pick guide, specifically using this repo as the example source.

I also added a link to this section from the "How to Use the Guide" section of the repo README.

Screenshot 2025-11-14 at 2 23 50 PM

@egrace479 egrace479 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 14, 2025
Copy link
Contributor

@NetZissou NetZissou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. Definitely need this!

@thompsonmj
Copy link
Contributor

Definitely helpful, though in this presentation, feels a bit 'meta'—like it maybe belongs in a CONTRIBUTING.md file rather than a seamless entry in the guide itself.

Perhaps it could be framed in a more generic way by frontloading with some example use-cases for what cherry picking does and when you might want to use it? Then offering the task of updating this repo itself as an example? Also linking to this page from the corresponding section under the Two Repo Problem.

@egrace479
Copy link
Member Author

egrace479 commented Nov 17, 2025

Definitely helpful, though in this presentation, feels a bit 'meta'—like it maybe belongs in a CONTRIBUTING.md file rather than a seamless entry in the guide itself.

Perhaps it could be framed in a more generic way by frontloading with some example use-cases for what cherry picking does and when you might want to use it? Then offering the task of updating this repo itself as an example? Also linking to this page from the corresponding section under the Two Repo Problem.

I see your point. It's hard to motivate, as git cherry-pick is basically just pulling a commit from elsewhere, which I haven't done outside this and the Two-Repo Problem case. I'm open to suggestions to give it a bit more of an introduction though.

I would argue that it doesn't belong in CONTRIBUTING.md though, since it's not sending changes back here, but pulling the changes made in the upstream repo. I certainly wouldn't want to set an expectation that one should contribute if they want to use the template. It was definitely made with the motivation to help end users though.

@egrace479
Copy link
Member Author

I feel like we should add a link from the two repo cherry-pick section back to this page too. @thompsonmj, what do you think?

Copy link
Contributor

@thompsonmj thompsonmj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a small suggestion, but looks good!

Co-authored-by: Matt Thompson <31709066+thompsonmj@users.noreply.github.com>
@egrace479 egrace479 merged commit dd19371 into main Nov 18, 2025
@egrace479 egrace479 deleted the feat/cherry-pick branch November 18, 2025 17:04
egrace479 added a commit to Imageomics/Imageomics-guide that referenced this pull request Nov 20, 2025
based on updating Imageomics Guide from Collab template

Pull from Collab Guide [PR 35](Imageomics/Collaborative-distributed-science-guide#35)

* Add link to cherry-pick guide for instructions on updating personalized sites

* Fix typo in acknowledgments

* Clarify description and add link to cherry-pick guide for more info

* Add some intro to the page

* Add a little extra context/clarity

Co-authored-by: Matt Thompson <31709066+thompsonmj@users.noreply.github.com>

---------

Co-authored-by: Matt Thompson <31709066+thompsonmj@users.noreply.github.com>
egrace479 added a commit to Imageomics/Imageomics-guide that referenced this pull request Nov 25, 2025
based on updating Imageomics Guide from Collab template

Pull from Collab Guide [PR 35](Imageomics/Collaborative-distributed-science-guide#35)

* Add link to cherry-pick guide for instructions on updating personalized sites

* Fix typo in acknowledgments

* Clarify description and add link to cherry-pick guide for more info

* Add some intro to the page

* Add a little extra context/clarity

Co-authored-by: Matt Thompson <31709066+thompsonmj@users.noreply.github.com>

---------

Co-authored-by: Matt Thompson <31709066+thompsonmj@users.noreply.github.com>
egrace479 added a commit to ABC-Center/ABC-guide that referenced this pull request Nov 25, 2025
Pull from Collab Guide [PR 35](Imageomics/Collaborative-distributed-science-guide#35)

based on updating Imageomics Guide from Collab template

* Add link to cherry-pick guide for instructions on updating personalized sites

* Fix typo in acknowledgments

* Clarify description and add link to cherry-pick guide for more info

* Add some intro to the page

* Add a little extra context/clarity

Co-authored-by: Matt Thompson <31709066+thompsonmj@users.noreply.github.com>

---------

Co-authored-by: Matt Thompson <31709066+thompsonmj@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants