Skip to content

Added sensitive information bit #20

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

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Added sensitive information bit #20

merged 2 commits into from
Sep 18, 2024

Conversation

fcerpe
Copy link
Contributor

@fcerpe fcerpe commented Sep 17, 2024

I added a few phrases about posting sensitive information.
I'm also trying the PR from gitkraken, just to spice it up

Summary by Sourcery

Update the contributing documentation to include guidelines on handling sensitive information, emphasizing the importance of not including sensitive data directly in the public guide.

Documentation:

  • Add guidelines to the contributing documentation about handling sensitive information, advising contributors to avoid including sensitive data directly in the guide and suggesting alternatives.

Copy link
Contributor

sourcery-ai bot commented Sep 17, 2024

Reviewer's Guide by Sourcery

This pull request adds a new paragraph to the contributing.md file, providing guidance on handling sensitive information in the publicly accessible guide.

File-Level Changes

Change Details Files
Added a paragraph about handling sensitive information
  • Introduced a warning about the public accessibility of the guide
  • Suggested creating a private password-protected document for sensitive information
  • Advised contacting maintainers if unsure about how to proceed
doc/contributing.md

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

Overall Comments:

  • Consider rewording the added paragraph for clarity and conciseness. Break it into shorter, more direct sentences about the steps to take with sensitive information.
  • There's a typo in 'participants codes'. It should be 'participants' codes'.
  • Please remove the comment about GitKraken from the PR description, as it's not relevant to the changes made.
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: 1 issue 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.

@@ -18,6 +18,8 @@ Each article/section of the website is a specific markdown (`.md`) file with (mo

If you're new to markdown, here's a quick [markdown cheatsheet](https://www.markdownguide.org/cheat-sheet/).

Before making any modification, remember that this guide is publicly accessible by anyone. If you want to add any potentially sensitive information (e.g. participants codes, passwords of shared accounts), consider making a private password-protected document that can be linked via the lab guide. If you're unsure about what to do or how to do, get in touch with the maintainers of the guide.
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (documentation): Clarify the phrase 'If you're unsure about what to do or how to do'

Consider rephrasing to 'If you're unsure about what to do or how to proceed' for better clarity.

Suggested change
Before making any modification, remember that this guide is publicly accessible by anyone. If you want to add any potentially sensitive information (e.g. participants codes, passwords of shared accounts), consider making a private password-protected document that can be linked via the lab guide. If you're unsure about what to do or how to do, get in touch with the maintainers of the guide.
Before making any modification, remember that this guide is publicly accessible by anyone. If you want to add any potentially sensitive information (e.g. participants codes, passwords of shared accounts), consider making a private password-protected document that can be linked via the lab guide. If you're unsure about what to do or how to proceed, get in touch with the maintainers of the guide.

@marcobarilari
Copy link
Contributor

LGTM, feel free to merge

@fcerpe fcerpe merged commit c55dade into main Sep 18, 2024
1 check passed
@marcobarilari marcobarilari deleted the fcerpe-patch-1 branch September 19, 2024 07:27
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.

2 participants