-
Notifications
You must be signed in to change notification settings - Fork 115
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
Add community documents #777
Conversation
Reviewer's Guide by SourceryThis pull request enhances the project's documentation by updating CONTRIBUTING.md to include a Code of Conduct reference and adding two new documents: CODE-OF-CONDUCT.md and SECURITY.md. The changes add community guidelines, security policy details, and minor formatting adjustments. Documentation Structure Flow Diagramgraph LR
A[CONTRIBUTING.md] --> B[CODE-OF-CONDUCT.md]
A --> C[SECURITY.md]
B --> D[Community Guidelines]
C --> E[Security Policy Details]
subgraph Documentation
A
B
C
end
subgraph Content
D
E
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @rhatdan - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a link to the CODE-OF-CONDUCT.md file in the README.md file as well.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
CONTRIBUTING.md
Outdated
respect all people who contribute through reporting issues, posting feature | ||
requests, updating documentation, submitting pull requests or patches, and other | ||
activities to any of the projects under the containers umbrella. The full code of conduct guidelines can be | ||
found [here](https://github.com/caradelia/ramalama/blob/main/CODE-OF-CONDUCT.md). |
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.
issue (bug_risk): Incorrect link to Code of Conduct
The link should point to containers/ramalama
, not caradelia/ramalama
.
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.
Ramalama is spelt RamaLama is most places these days, but that's minor
They should be spelled RamaLama everywhere, unless using as a command. |
Update CONTRIBUTING.md Create CODE-OF-CONDUCT.md Create SECURITY.md Replaces: containers#737 Originally written by caradelia (Cara Delia) Signed-off-by: Daniel J Walsh <[email protected]>
@TomSweeneyRedHat PTAL |
Update CONTRIBUTING.md
Create CODE-OF-CONDUCT.md
Create SECURITY.md
Replaces: #737
Originally written by caradelia (Cara Delia)
Summary by Sourcery
Add community documents, including contributing guidelines, a code of conduct, and a security policy.
Documentation: