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

Buf plugin example #103

Merged
merged 3 commits into from
Dec 17, 2024
Merged

Conversation

dv-stewarts
Copy link
Contributor

I wanted to make it easier for people to understand how to use the api-linter as a buf plugin, so I created an example project using the bookstore example.proto (Which embarrassingly fails linting) and added an explanation to the docs.

I also updated some stale references and text in the docs which still referred to AIP pages.

.gitignore Outdated Show resolved Hide resolved
@toumorokoshi
Copy link
Member

Which embarrassingly fails linting

Did you import the aeps example, or the aepc example?

The aepc example is fully compliant - so perhaps if you pulled in the aeps one I can send a PR to update that one.

Copy link
Member

@toumorokoshi toumorokoshi left a comment

Choose a reason for hiding this comment

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

LGTM, sans the one comment on .gitignore. Once that's addressed I'm happy to do the merge. Thank you!

@dv-stewarts
Copy link
Contributor Author

Did you import the aeps example, or the aepc example?

The aepc example is fully compliant - so perhaps if you pulled in the aeps one I can send a PR to update that one.

It was the aeps example. I've updated with the one from aepc and that does, indeed, pass. I think it's worth updating the example to ensure compliance.

@toumorokoshi toumorokoshi merged commit 3c3b820 into aep-dev:main Dec 17, 2024
1 check passed
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