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

chore: Add warning to readme about running code from strangers #59

Merged
merged 1 commit into from
Nov 13, 2024

Conversation

martimlobao
Copy link
Owner

@martimlobao martimlobao commented Nov 13, 2024

  • add readme warning
  • add bootstrap function to re-run everything after first install

Summary by Sourcery

Add a warning to the README about running code from strangers and update the README to include a new bootstrap function for re-running installations.

Documentation:

  • Add a warning to the README about the risks of running code from untrusted sources.

Chores:

  • Update README to include a new bootstrap function for re-running everything after the first install.

- add readme warning
- add bootstrap function to re-run everything after first install
Copy link
Contributor

sourcery-ai bot commented Nov 13, 2024

Reviewer's Guide by Sourcery

This PR updates the README.md file to include a security warning about running code from unknown sources and reorganizes the script descriptions for better clarity. The changes focus on improving documentation and user safety awareness.

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

File-Level Changes

Change Details Files
Reorganized and clarified script descriptions in the documentation
  • Reordered script descriptions to match execution order
  • Updated script descriptions to be more precise
  • Added description for bash_traceback.sh helper script
README.md
Enhanced security awareness in installation instructions
  • Added explicit warning about running code from strangers on the internet
  • Added the full GitHub URL as the recommended installation method
  • Moved the shorter URL option to a secondary position with appropriate cautionary notes
README.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

trunk-io bot commented Nov 13, 2024

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

@martimlobao martimlobao enabled auto-merge (squash) November 13, 2024 09:45
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 @martimlobao - 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: 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 and I'll use the feedback to improve your reviews.

README.md Show resolved Hide resolved
@martimlobao martimlobao disabled auto-merge November 13, 2024 09:55
@martimlobao martimlobao merged commit 9d556b7 into main Nov 13, 2024
8 checks passed
@martimlobao martimlobao deleted the chore/readme-warning branch November 13, 2024 09:55
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.

1 participant