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

Adding GhostBSD Contributor's Guide and is work in progress #60

Merged
merged 6 commits into from
Jul 11, 2024

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Jul 10, 2024

This document is meant to help people who want to contribute to GhostBSD.

Summary by Sourcery

Introduced a new GhostBSD Contributor's Guide to provide detailed guidelines and best practices for contributors, including sections on becoming a contributor, responsibilities, using GitHub, commit messages, pull requests, code reviews, handling bug reports, testing, documentation, communication, and resources.

  • Documentation:
    • Added a comprehensive GhostBSD Contributor's Guide to help new and existing contributors understand responsibilities, workflows, and best practices.

This document is meant to help people that want to contribute to GhostBSD.
@ericbsd ericbsd requested review from a team as code owners July 10, 2024 23:47
Copy link
Contributor

sourcery-ai bot commented Jul 10, 2024

Reviewer's Guide by Sourcery

This pull request introduces a new document, the 'GhostBSD Contributor's Guide', aimed at helping new contributors understand the responsibilities, workflows, and best practices for contributing to the GhostBSD project. Additionally, it updates the index to include a link to this new guide.

File-Level Changes

Files Changes
source/index.md
source/contributor/ghostbsd-contributors-guide.md
Introduced a new 'GhostBSD Contributor's Guide' and updated the index to include a link to this guide.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

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 and they look great!

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: 6 issues found

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 to tell me if it was helpful.

source/contributor/ghostbsd-contributors-guide.md Outdated Show resolved Hide resolved
source/contributor/ghostbsd-contributors-guide.md Outdated Show resolved Hide resolved
source/contributor/ghostbsd-contributors-guide.md Outdated Show resolved Hide resolved
source/contributor/ghostbsd-contributors-guide.md Outdated Show resolved Hide resolved
source/contributor/ghostbsd-contributors-guide.md Outdated Show resolved Hide resolved
source/contributor/ghostbsd-contributors-guide.md Outdated Show resolved Hide resolved
ericbsd and others added 5 commits July 10, 2024 20:48
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@ericbsd ericbsd merged commit a76c2e7 into master Jul 11, 2024
1 check passed
@ericbsd ericbsd deleted the contiributors-guide branch July 11, 2024 00:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant