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

docs: fixing typos in markdown files #462

Merged
merged 1 commit into from
Aug 5, 2024
Merged

Conversation

jayPare
Copy link
Contributor

@jayPare jayPare commented Aug 2, 2024

Signed-off-by: Jeremy Pare jeremy.pare@outlook.com

Copy link
Contributor

Choose a reason for hiding this comment

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

The autogen.md file is automatically generated when the .proto files are updated and should not be modified manually. Any typo's in the comments of the .proto files need to be corrected there and the new files generated and checked into the repository.

Please remove the autogen.md from the checkin to allow the ci checks to pass since it is comparing the file to an automatically generated mirror of the file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@sandersms
Copy link
Contributor

@jayPare Please fix the autogen.md file for the storage per the comment above and correct the CommitLint check.

For the commitlint check, the commit message must not end with a full stop ".", refer to the details on the CI checks.

@jayPare jayPare changed the title docs: fixing typos in markdown files. docs: fixing typos in markdown files Aug 2, 2024
@jayPare jayPare force-pushed the main branch 2 times, most recently from 126c23d to 88abe5b Compare August 2, 2024 20:01
@sandersms
Copy link
Contributor

@jayPare The commilint is still failing and needs to be fixed before it can be approved/merged.

Signed-off-by: Jeremy Pare <jeremy.pare@outlook.com>
@jayPare
Copy link
Contributor Author

jayPare commented Aug 5, 2024

@jayPare The commilint is still failing and needs to be fixed before it can be approved/merged.

I fixed the initial commit with a forced push. I hope it will pass now!

Copy link
Contributor

@artek-koltun artek-koltun left a comment

Choose a reason for hiding this comment

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

LGTM

@artek-koltun artek-koltun merged commit 9348921 into opiproject:main Aug 5, 2024
9 checks 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.

3 participants