Skip to content

📝 🐛 Update contributing.md #65

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

CRIMSONHydra
Copy link
Contributor

@CRIMSONHydra CRIMSONHydra commented May 13, 2025

In the how to contribute section:

  1. Changed the order to ensure dependencies are installed locally
  2. Added more clarity for different OS on activating venv
  3. app.py doesnt exist, changed to main.py 🐛

Summary by Sourcery

Update the contributing guide to clarify environment setup, renumber steps, and fix the development server run command.

Documentation:

  • Reorder instructions to create a virtual environment before installing dependencies
  • Add MacOS/Linux and Windows commands for activating the virtual environment
  • Correct the development server command to use python main.py instead of python app.py

1. Changed the order to ensure dependencies are installed locally
2. Added more clarity for different OS on activating venv
3. app.py doesnt exist, changed to main.py 🐛
Copy link
Contributor

sourcery-ai bot commented May 13, 2025

Reviewer's Guide

Refactors the contributing guide by moving virtual environment creation ahead of dependency installation (with corresponding step renumbering), adds clear OS-specific venv activation instructions, and corrects the development server launch command from app.py to main.py.

File-Level Changes

Change Details Files
Reorder setup steps and update step numbers
  • Move venv creation before installing dependencies
  • Increment subsequent step indices to accommodate new step
  • Adjust headings for branch creation, .env setup, etc.
contributing.md
Clarify OS-specific venv activation
  • Add separate activation commands for macOS/Linux and Windows
  • Ensure proper code block indentation
contributing.md
Correct development server startup command
  • Replace python app.py with python main.py in the run instructions
contributing.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!

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

Corrected windows script

Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
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 @CRIMSONHydra - I've reviewed your changes - here's some feedback:

  • Fix the typo in step 10: change “Format you code” to “Format your code.”
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: 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.

Typo

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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