Create an organization-level readme for Charmed HPC github org#22
Merged
NucciTheBoss merged 9 commits intocharmed-hpc:mainfrom Jul 1, 2025
Merged
Create an organization-level readme for Charmed HPC github org#22NucciTheBoss merged 9 commits intocharmed-hpc:mainfrom
NucciTheBoss merged 9 commits intocharmed-hpc:mainfrom
Conversation
NucciTheBoss
requested changes
Jun 24, 2025
Member
NucciTheBoss
left a comment
There was a problem hiding this comment.
I'm really liking the structure and content of the README here. I made some suggestions about how we could build out the content more such as expanding the FAQ section and being aggressively specific that failing CI results in insta-death, but feel free to modify as you see necessary.
I also suggested adding the Charmed HPC/Ubuntu HPC community logo to the header to make the profile README visually pop.
Co-authored-by: Jason Nucciarone <40342202+NucciTheBoss@users.noreply.github.com>
NucciTheBoss
requested changes
Jul 1, 2025
Member
NucciTheBoss
left a comment
There was a problem hiding this comment.
Looks great! Just some suggestions about styling and file path structure. Once you've addressed those, I'm good to merge this PR.
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pre-submission checklist
Summary of changes
This PR creates an org-level README.md for Charmed HPC's Github organization. It covers the basics of who Charmed HPC is, how to contact the team, highlights of contributing and documentation expectations, and some FAQs.
Related Issues, PRs, and Discussions
These changes follow along after, and refer to, the recently merged org-level CONTRIBUTING.md guide.
Docs
Or:
This PR is itself documentation and does not need other documentation updates. There will be follow up RTD documentation updates to align that set of documentation with these updates.