-
Notifications
You must be signed in to change notification settings - Fork 4
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
Conversation
Reviewer's Guide by SourceryThis 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
Tips
|
for more information, see https://pre-commit.ci
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 @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
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
doc/contributing.md
Outdated
@@ -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. |
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.
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.
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. |
LGTM, feel free to merge |
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: