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

chore: add markdown link & lint ci #1684

Merged
merged 8 commits into from
Sep 13, 2024

Conversation

xuan-cao-swi
Copy link
Contributor

Verified

This commit was signed with the committer’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
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
Copy link
Contributor

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?

Copy link
Contributor Author

@xuan-cao-swi xuan-cao-swi Aug 16, 2024

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
Copy link
Contributor

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?

Copy link
Contributor Author

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.

xuan-cao-swi and others added 3 commits August 16, 2024 13:49

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was signed with the committer’s verified signature.

Verified

This commit was signed with the committer’s verified signature.
…etry-ruby into markdownlint-link
Copy link
Contributor

@kaylareopelle kaylareopelle left a comment

Choose a reason for hiding this comment

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

Thank you!

@mwear mwear changed the title chore: add markdwon link & lint ci chore: add markdown link & lint ci Aug 23, 2024
xuan-cao-swi and others added 3 commits August 26, 2024 10:53

Verified

This commit was signed with the committer’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@mwear mwear merged commit d9b2972 into open-telemetry:main Sep 13, 2024
62 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants