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

update dev guide #64

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Ubayed-Bin-Sufian
Copy link
Contributor

@Ubayed-Bin-Sufian Ubayed-Bin-Sufian commented Mar 21, 2025

Summary of Changes in PR:

  1. Added clarification for different email platforms (Gmail, Yahoo, Outlook).
  2. Emphasized checking code quality before making a PR.
  3. Included a direct link to report issues.

Summary by Sourcery

Update the development guide to include instructions for different email platforms and emphasize code quality checks before submitting pull requests. Also, include a direct link to report issues.

Documentation:

  • Add instructions for using the extension with Gmail, Yahoo, and Outlook.
  • Emphasize the importance of code formatting and linting before submitting a pull request.
  • Include a direct link to the issue reporting page.

Copy link

sourcery-ai bot commented Mar 21, 2025

Reviewer's Guide by Sourcery

This pull request updates the development guide by clarifying installation instructions for different email platforms, emphasizing code quality checks before pull requests, and providing a direct link for reporting issues.

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

File-Level Changes

Change Details Files
The installation instructions were updated to clarify the steps for different email platforms and to provide more specific guidance for Google Groups, Gmail, Yahoo, and Outlook.
  • Added specific instructions for Google Groups.
  • Added instructions for Gmail, Yahoo, and Outlook.
  • Minor formatting changes for clarity.
README.md
Added instructions to check code quality before submitting a pull request, including formatting, linting, and automatic error fixing.
  • Added instructions to format the code using npm run format.
  • Added instructions to check for issues using npm run check.
  • Added instructions to automatically fix safe linting errors using npm run fix.
README.md
A direct link to the issues page was added to the contributing section.
  • Added a link to the GitHub issues page for bug reporting.
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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

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

Overall Comments:

  • Consider adding a brief explanation of what npm run format, npm run check, and npm run fix do.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 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.

@Ubayed-Bin-Sufian
Copy link
Contributor Author

@hongquan please review. Thanks!

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