Skip to content

Create an organization-level readme for Charmed HPC github org#22

Merged
NucciTheBoss merged 9 commits intocharmed-hpc:mainfrom
AshleyCliff:README
Jul 1, 2025
Merged

Create an organization-level readme for Charmed HPC github org#22
NucciTheBoss merged 9 commits intocharmed-hpc:mainfrom
AshleyCliff:README

Conversation

@AshleyCliff
Copy link
Contributor

@AshleyCliff AshleyCliff commented Jun 23, 2025

Pre-submission checklist

  • I read and followed the CONTRIBUTING guidelines.
  • I have insured that lint, typecheck, and unit tests complete successfully.

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

  • I have created a pull request to add or update relevant documentation in charmed-hpc/docs or another documentation location.

Or:

  • I confirm that this pull request requires no changes or additions to documentation.

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.

Copy link
Member

@NucciTheBoss NucciTheBoss left a comment

Choose a reason for hiding this comment

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

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.

Copy link
Member

@NucciTheBoss NucciTheBoss left a comment

Choose a reason for hiding this comment

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

Looks great! Just some suggestions about styling and file path structure. Once you've addressed those, I'm good to merge this PR.

@AshleyCliff AshleyCliff marked this pull request as ready for review July 1, 2025 16:25
@AshleyCliff AshleyCliff requested a review from a team as a code owner July 1, 2025 16:25
Copy link
Member

@NucciTheBoss NucciTheBoss left a comment

Choose a reason for hiding this comment

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

LGTM! :shipit:

@NucciTheBoss NucciTheBoss merged commit fa5a09c into charmed-hpc:main Jul 1, 2025
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants