-
Notifications
You must be signed in to change notification settings - Fork 6
Docs: Add license, code of conduct, Contributing and security guidelines #163
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Add license, code of conduct, Contributing and security guidelines #163
Conversation
LakshmiSaiHarika
left a comment
There was a problem hiding this 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.
9e351fb to
ac4e9e4
Compare
benland72
left a comment
There was a problem hiding this 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
left a comment
There was a problem hiding this 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.
DGonzalezVillal
left a comment
There was a problem hiding this 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.
3cb48e8
ac4e9e4 to
3cb48e8
Compare
3cb48e8 to
1e855e4
Compare
npmccallum
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
Content is very good!
-
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.
-
Please make sure to include the "disclaimer" that @benland72 mentioned.
-
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.
-
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.
ae3bf53 to
cb5f466
Compare
I organized my content into a text with paragraphs and spacing to make it more readable as per the above comments. |
DGonzalezVillal
left a comment
There was a problem hiding this 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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.
There was a problem hiding this comment.
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.
cb5f466 to
74dcd02
Compare
Signed-off-by: Harika Nittala <[email protected]>
74dcd02 to
4dd25d7
Compare
Signed-off-by: Harika Nittala <[email protected]>
Signed-off-by: Harika Nittala <[email protected]>
Signed-off-by: Harika Nittala <[email protected]> SECURITY.md Signed-off-by: Harika Nittala <[email protected]>
4dd25d7 to
3577835
Compare
|
Thanks for your re-review @DGonzalezVillal! I addressed your above feedback. |
Harika addressed the comments, Nathaniel OOO
Please review the overall draft of this doc PR.
This PR features the following: