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

fix format and add links for contribute.md #10232

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

Conversation

pierceroberts
Copy link

@pierceroberts pierceroberts commented Feb 28, 2025

Pull Request Check List

Resolves: #issue-number-here

  • Added tests for changed code.
  • Updated documentation for changed code.

Summary by Sourcery

This PR fixes relative links and updates external resources to use absolute links in contributing.md.

Documentation:

  • Fix relative links in contributing.md.
  • Update contributing.md to use absolute links for external resources.

Copy link

sourcery-ai bot commented Feb 28, 2025

Reviewer's Guide by Sourcery

This pull request enhances the contributing documentation by adding direct links to relevant resources such as the FAQ, issue tracker, discussions, and Discord server. It also improves the formatting of notes within the documentation for better readability by using HTML tags.

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

File-Level Changes

Change Details Files
Updated the contributing documentation to include direct links to resources and improved the formatting of notes.
  • Replaced generic references to FAQ, issue tracker, Discussions, and Discord with direct links.
  • Improved the formatting of notes within the contributing documentation for better readability by using HTML tags.
docs/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!
  • 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

@pierceroberts pierceroberts marked this pull request as draft February 28, 2025 03:41
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 @pierceroberts - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The added <ins> tags don't seem necessary and may not render as intended in all contexts.
  • Consider whether the links should be absolute or relative for better maintainability.
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: 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.

@pierceroberts pierceroberts marked this pull request as ready for review February 28, 2025 05:20
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 @pierceroberts - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The added <ins> tags don't seem to render correctly on GitHub; consider using a different formatting approach for the notes.
  • It might be worth checking how the links render on the live site to ensure they are working as expected.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue 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.

or [Discord].
* **Check the [FAQ](faq.md)** for a list of common questions and problems.
* **Check the [blog](https://python-poetry.org/blog/)** for release notes from recent releases, including steps for upgrading and known issues.
* **Check that your issue does not already exist** in the [issue tracker]( https://github.com/python-poetry/poetry/issues).
Copy link

Choose a reason for hiding this comment

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

issue (typo): Extra space in issue tracker link.

There's an extra space before the URL for the issue tracker. Please remove it.

Suggested change
* **Check that your issue does not already exist** in the [issue tracker]( https://github.com/python-poetry/poetry/issues).
* **Check that your issue does not already exist** in the [issue tracker](https://github.com/python-poetry/poetry/issues).

@pierceroberts
Copy link
Author

So the <ins> make it more distinguishable with the amount of text and is a preference, I do think it makes it easier to find.

As for the links I was simply making them work and cleaning up the inconsistencies. There were some that went to links and some that just went to the bottom. And it made more sense to have one way.

@radoering
Copy link
Member

I think you are on the wrong track. The files in the docs folder are not optimized for being viewed via github but for generating our documentation.

@pierceroberts
Copy link
Author

Oh interesting....
How does that process work @radoering ?
I thats the case, we can revert some of the changes. I think the links at the bottom can at least get updated.

@radoering
Copy link
Member

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