fix format and add links for contribute.md
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.mdto use absolute links for external resources.
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. |
|
docs/contributing.md |
Tips and commands
Interacting with Sourcery
-
Trigger a new review: Comment
@sourcery-ai reviewon 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 issueto create an issue from it. -
Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. -
Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. -
Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. -
Resolve all Sourcery comments: Comment
@sourcery-ai resolveon 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 dismisson 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 reviewto trigger a new review! -
Generate a plan of action for an issue: Comment
@sourcery-ai planon 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
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
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.
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.
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.
How does that process work @radoering ?
The source code is here: https://github.com/python-poetry/website
See https://github.com/python-poetry/website?tab=readme-ov-file#local-development