Skip to content
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

Merged
merged 1 commit into from
Feb 10, 2025
Merged

Add community documents #777

merged 1 commit into from
Feb 10, 2025

Conversation

rhatdan
Copy link
Member

@rhatdan rhatdan commented Feb 10, 2025

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:

  • Add a code of conduct and security policy.
  • Update the contributing guidelines.

Copy link
Contributor

sourcery-ai bot commented Feb 10, 2025

Reviewer's Guide by Sourcery

This 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 Diagram

graph 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
Loading

File-Level Changes

Change Details Files
Updated CONTRIBUTING.md to integrate code of conduct navigation and minor formatting improvements.
  • Added a link to the Code of Conduct in the navigation section.
  • Adjusted formatting in code examples and git configuration snippets.
CONTRIBUTING.md
Created CODE-OF-CONDUCT.md to provide community and contributor guidelines.
  • Introduced a comprehensive Code of Conduct outlining expected behaviors for contributors.
  • Detailed unacceptable behaviors and the process for reporting issues.
CODE-OF-CONDUCT.md
Created SECURITY.md to define the security and disclosure information policy.
  • Outlined the security policy in accordance with the Containers Projects’ guidelines.
SECURITY.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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).
Copy link
Contributor

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.

Copy link
Collaborator

@ericcurtin ericcurtin left a 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

@rhatdan
Copy link
Member Author

rhatdan commented Feb 10, 2025

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]>
@rhatdan
Copy link
Member Author

rhatdan commented Feb 10, 2025

@TomSweeneyRedHat PTAL

@rhatdan rhatdan changed the title Add communicy documents Add community documents Feb 10, 2025
@rhatdan rhatdan merged commit ffa5ae9 into containers:main Feb 10, 2025
13 of 16 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.

3 participants