-
-
Notifications
You must be signed in to change notification settings - Fork 305
docs(contributing): add poetry and lychee tips #1745
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
base: master
Are you sure you want to change the base?
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1745 +/- ##
==========================================
+ Coverage 97.33% 97.84% +0.51%
==========================================
Files 42 60 +18
Lines 2104 2604 +500
==========================================
+ Hits 2048 2548 +500
Misses 56 56
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| # Make sure you have the latest version of poetry installed | ||
| poetry self update |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This really depends on how poetry is installed. It will not work with system installation, mise or asdf based installation...
So not sure we should include this instruction.
However, instead of forcing an update which might not be required, saying that "we require poetry>=X.Y.Z, you can verify with poetry --version" might be a better option
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed
| Also, we use [Lychee](https://lychee.cli.rs/) to check for broken links in the documentation. | ||
|
|
||
| ```bash | ||
| # Check for broken links in the documentation | ||
| lychee . | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is a TLDR, broken link checking, with a tool not installed with the other dependencies but run on CI, may not be worth adding there. Breaking links while contributing is rare enough to just let it fail on CI if it happends, WDYT ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed, also it's not nice to drop this responsibility on other. I think is better the PR runs, reports and someone can take action if they want
Updated
contributing_tldr.md.