Skip to content

Add links to repos with good READMEs as examples for repo types#50

Merged
egrace479 merged 6 commits intomainfrom
gh-update
Jan 24, 2026
Merged

Add links to repos with good READMEs as examples for repo types#50
egrace479 merged 6 commits intomainfrom
gh-update

Conversation

@egrace479
Copy link
Copy Markdown
Member

I also included a link to the Code Checklist in a pro tip box, and standardized the file+extension formatting (when not in a URL).

Resolves #47

@egrace479 egrace479 requested a review from thompsonmj January 23, 2026 23:13
@egrace479 egrace479 added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 23, 2026
Copy link
Copy Markdown
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.

Approved with optional suggestion!

@egrace479 egrace479 requested a review from thompsonmj January 24, 2026 01:10
@egrace479
Copy link
Copy Markdown
Member Author

@thompsonmj, I reformatted (we tend to use - for bullet points and have on other pages, so went for overall consistency), and reformulated the lists under the README section to be subsections for easier scanning and linkability.

@egrace479 egrace479 merged commit 8506059 into main Jan 24, 2026
1 check passed
@egrace479 egrace479 deleted the gh-update branch January 24, 2026 02:25
egrace479 added a commit to Imageomics/Imageomics-guide that referenced this pull request Jan 27, 2026
Pull from Collab Guide [PR 50](Imageomics/Collaborative-distributed-science-guide#50)

* Add links to repos with good readmes as examples

* standardize file+extension formatting and fix typo

* Add pro-tip about the code checklist with link

* Add guiding principles for a good readme

Co-authored-by: Matt Thompson <[email protected]>

* Fix formatting

* Reformulate as subsections for easier scanning

---------

Co-authored-by: Matt Thompson <[email protected]>
egrace479 added a commit to ABC-Center/ABC-guide that referenced this pull request Jan 27, 2026
Pull from Collab Guide [PR 50](Imageomics/Collaborative-distributed-science-guide#50)

* Add links to repos with good readmes as examples

* standardize file+extension formatting and fix typo

* Add pro-tip about the code checklist with link

* Add guiding principles for a good readme

Co-authored-by: Matt Thompson <[email protected]>

* Fix formatting

* Reformulate as subsections for easier scanning

---------

Co-authored-by: Matt Thompson <[email protected]>
egrace479 added a commit to Imageomics/Imageomics-guide that referenced this pull request Jan 28, 2026
Pull from Collab Guide [PR 50](Imageomics/Collaborative-distributed-science-guide#50)

* Add links to repos with good readmes as examples

* standardize file+extension formatting and fix typo

* Add pro-tip about the code checklist with link

* Add guiding principles for a good readme

Co-authored-by: Matt Thompson <[email protected]>

* Fix formatting

* Reformulate as subsections for easier scanning

---------

Co-authored-by: Matt Thompson <[email protected]>
egrace479 added a commit to ABC-Center/ABC-guide that referenced this pull request Jan 28, 2026
Pull from Collab Guide [PR 50](Imageomics/Collaborative-distributed-science-guide#50)

* Add links to repos with good readmes as examples

* standardize file+extension formatting and fix typo

* Add pro-tip about the code checklist with link

* Add guiding principles for a good readme

Co-authored-by: Matt Thompson <[email protected]>

* Fix formatting

* Reformulate as subsections for easier scanning

---------

Co-authored-by: Matt Thompson <[email protected]>
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.

Add links (as examples) to a few repos with good READMEs

2 participants