-
Notifications
You must be signed in to change notification settings - Fork 251
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
chore: add markdown link & lint ci #1684
Conversation
README.md
Outdated
@@ -71,7 +71,6 @@ Apache 2.0 - See [LICENSE][license-url] for more information. | |||
[ci-image]: https://github.com/open-telemetry/opentelemetry-ruby/workflows/CI/badge.svg?event=push | |||
[contrib-repo]: https://github.com/open-telemetry/opentelemetry-ruby-contrib | |||
[contrib-instrumentations]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation | |||
[examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples |
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.
I'm surprised the examples directory isn't referenced in the main README anymore. Should we add a reference back to the README?
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.
Probably because [examples-github]
is not used anywhere in this readme, so the markdownlint auto-correct removed it. I updated the readme to include it under Useful Links
CONTRIBUTING.md
Outdated
@@ -154,8 +155,8 @@ to ensure that your code complies before opening a pull request. | |||
We also use Yard to generate class documentation automatically. Among other | |||
things, this means: | |||
|
|||
* Methods and arguments should include the appropriate type annotations | |||
* You can use markdown formatting in your documentation comments | |||
* Methods and arguments should include the appropraite type annotations |
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 confuses me a little bit.
It seems like code spell ran and passed on this PR, but it noticed something might be wrong with this word: https://github.com/open-telemetry/opentelemetry-ruby/actions/runs/10408237991/job/28825243501?pr=1684#step:3:45
@dmathieu, is this expected behavior?
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.
I think markdownlint auto-correct made this happen. Fixed it.
But it's surprising that code spell didn't catch it.
…etry-ruby into markdownlint-link
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.
Thank you!
Similar to open-telemetry/opentelemetry-ruby-contrib#1096