Skip to content

Conversation

@LakshmiSaiHarika
Copy link
Contributor

@LakshmiSaiHarika LakshmiSaiHarika commented Oct 8, 2025

Please review the overall draft of this doc PR.

This PR features the following:

  • Added MIT License for this project.
  • Added code of conduct to highlight the guidelines to follow in order to make contributions in this project.
  • Added Contributing guide to explain the procedure for making contributions in this project.
  • Added Security Guidelines to report a security bug.

Copy link
Contributor Author

@LakshmiSaiHarika LakshmiSaiHarika left a comment

Choose a reason for hiding this comment

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

Please help me with few of the questions I posted in the comments section.

@LakshmiSaiHarika LakshmiSaiHarika force-pushed the add-opensource-documentation branch 3 times, most recently from 9e351fb to ac4e9e4 Compare October 14, 2025 22:02
benland72
benland72 previously approved these changes Oct 15, 2025
Copy link

@benland72 benland72 left a comment

Choose a reason for hiding this comment

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

The updates look good to me. Thank you!

markg-github
markg-github previously approved these changes Oct 15, 2025
Copy link
Contributor

@markg-github markg-github left a comment

Choose a reason for hiding this comment

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

I added a lot of (19) comments - all minor. (It helps me stay engaged. :))

Approving and deferring to Ben for whether describing squashing, as he describes, is gating.

Copy link
Contributor

@DGonzalezVillal DGonzalezVillal left a comment

Choose a reason for hiding this comment

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

Some wording and content suggestions. Please also look through Mark's comments because he also found several grammar and content mistakes.

@LakshmiSaiHarika LakshmiSaiHarika force-pushed the add-opensource-documentation branch from ac4e9e4 to 3cb48e8 Compare October 15, 2025 22:22
Copy link
Collaborator

@npmccallum npmccallum left a comment

Choose a reason for hiding this comment

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

  1. Content is very good!

  2. Be sure to wrap all files at an 80 column boundary. Keep in mind the rule about Markdown that it should be readable from both a terminal and the web.

  3. Please make sure to include the "disclaimer" that @benland72 mentioned.

  4. Sometimes you write long paragraphs with no wrapping. Other times, you write with a new sentence on each line. Markdown should flow like good English text with paragraphs and spacing to make it readable.

  5. There's a good Markdown style guide here: https://github.com/carwin/markdown-styleguide You might consider it as good advice. But remember, all rules have a time when they should be broken.

@LakshmiSaiHarika LakshmiSaiHarika force-pushed the add-opensource-documentation branch 2 times, most recently from ae3bf53 to cb5f466 Compare October 22, 2025 16:34
@LakshmiSaiHarika
Copy link
Contributor Author

  1. Content is very good!
  2. Be sure to wrap all files at an 80 column boundary. Keep in mind the rule about Markdown that it should be readable from both a terminal and the web.
  3. Please make sure to include the "disclaimer" that @benland72 mentioned.
  4. Sometimes you write long paragraphs with no wrapping. Other times, you write with a new sentence on each line. Markdown should flow like good English text with paragraphs and spacing to make it readable.
  5. There's a good Markdown style guide here: https://github.com/carwin/markdown-styleguide You might consider it as good advice. But remember, all rules have a time when they should be broken.

I organized my content into a text with paragraphs and spacing to make it more readable as per the above comments.
Please take a look

Copy link
Contributor

@DGonzalezVillal DGonzalezVillal left a comment

Choose a reason for hiding this comment

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

Just some proof reading things and then a comment around the mkosi reference. Is there a specific reason why we mention mkosi in the code of conduct? If not I think it makes more sense to move the mksoi reference to the contribution guide.

CONTRIBUTING.md Outdated

PRs for new features should include some background on what use cases the new code is trying to address. When possible and when it makes sense, try to break up larger PRs into smaller ones - it's easier to review smaller code changes. But, only if those smaller ones make sense as stand-alone PRs.

When *adding new operating system images or modifying existing ones*, please use mkosi to build your host/guest image and verify that it boots successfully on your system before submitting a pull request. This ensures that the functionality being introduced is working as expected prior to code review.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When *adding new operating system images or modifying existing ones*, please use mkosi to build your host/guest image and verify that it boots successfully on your system before submitting a pull request. This ensures that the functionality being introduced is working as expected prior to code review.
When *adding new operating system images or modifying existing ones*, please use [mkosi](https://github.com/systemd/mkosi) to build your host/guest image and verify that it boots successfully on your system before submitting a pull request. This ensures that the functionality being introduced is working as expected prior to code review.

I think referencing the mkosi tool makes more sense here.

Copy link
Contributor Author

@LakshmiSaiHarika LakshmiSaiHarika Oct 24, 2025

Choose a reason for hiding this comment

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

I added mkosi hyperlink as per your suggestion.

@LakshmiSaiHarika LakshmiSaiHarika force-pushed the add-opensource-documentation branch from cb5f466 to 74dcd02 Compare October 24, 2025 22:26
Signed-off-by: Harika Nittala <[email protected]>
@LakshmiSaiHarika LakshmiSaiHarika force-pushed the add-opensource-documentation branch from 74dcd02 to 4dd25d7 Compare October 24, 2025 22:29
@LakshmiSaiHarika LakshmiSaiHarika force-pushed the add-opensource-documentation branch from 4dd25d7 to 3577835 Compare October 24, 2025 22:40
@LakshmiSaiHarika
Copy link
Contributor Author

LakshmiSaiHarika commented Oct 24, 2025

Thanks for your re-review @DGonzalezVillal! I addressed your above feedback.

@DGonzalezVillal DGonzalezVillal enabled auto-merge (rebase) October 29, 2025 20:51
@DGonzalezVillal DGonzalezVillal dismissed npmccallum’s stale review October 29, 2025 20:52

Harika addressed the comments, Nathaniel OOO

@DGonzalezVillal DGonzalezVillal merged commit b5ad665 into AMDEPYC:main Oct 29, 2025
7 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.

6 participants