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

Reworked the CoC to simplify it. #77

Merged
3 commits merged into from
Dec 17, 2024
Merged

Reworked the CoC to simplify it. #77

3 commits merged into from
Dec 17, 2024

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Dec 17, 2024

I reworked it to be straight to the point.

Summary by Sourcery

Documentation:

  • Simplified the GhostBSD Community Code of Conduct to make it more concise and direct.

@ericbsd ericbsd self-assigned this Dec 17, 2024
@ericbsd ericbsd requested review from a team as code owners December 17, 2024 11:45
Copy link
Contributor

sourcery-ai bot commented Dec 17, 2024

Reviewer's Guide by Sourcery

The Code of Conduct has been restructured and simplified while maintaining its core principles. The implementation focuses on a more concise format with clear sections and bullet points, replacing the previous lengthy narrative style.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Restructured the main principles section
  • Condensed the six core principles into five numbered items
  • Simplified the language and removed redundant explanations
  • Added clear, concise descriptions for each principle
source/CoC.md
Added new organized sections for clarity
  • Created a dedicated 'Unacceptable Behavior' section with bullet points
  • Added a clear 'Scope' section defining where the CoC applies
  • Introduced a 'Reporting and Accountability' section with specific guidance
source/CoC.md
Removed verbose explanations and examples
  • Removed detailed explanations of each principle
  • Eliminated redundant examples and scenarios
  • Removed the attribution section about the CoC's origins
source/CoC.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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 @ericbsd - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider keeping the attribution section that acknowledges the CoC's origins from FreeBSD, LLVM, and Django projects - it's important to maintain proper credit.
  • While the new structure is clearer, consider retaining some specific examples of both acceptable and unacceptable behaviors to provide concrete guidance to community members.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

@ghost
Copy link

ghost commented Dec 17, 2024

LGTM

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

LGTM

@ghost ghost merged commit dc29507 into master Dec 17, 2024
1 check passed
@ghost ghost deleted the ericbsd-patch-1 branch December 17, 2024 12:29
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

1 participant