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

Fix spacing of README.md header and add linting to ensure it remains. #443

Merged
merged 5 commits into from
Jul 13, 2023

Conversation

pwtyler
Copy link
Member

@pwtyler pwtyler commented Jul 7, 2023

Two trailing spaces are required for single line breaks to appear in Markdown's rendered view.
Adds github action to check for invalid spacing of the Plugin's README header.

@pwtyler pwtyler changed the title Add README.md spacing linting Fix spacing of README.md header and add linting to ensure it remains. Jul 13, 2023
@pwtyler
Copy link
Member Author

pwtyler commented Jul 13, 2023

Before

Screen Shot 2023-07-12 at 10 50 03 PM

After

Screen Shot 2023-07-12 at 10 50 39 PM

@pwtyler pwtyler marked this pull request as ready for review July 13, 2023 05:52
@pwtyler pwtyler requested review from a team as code owners July 13, 2023 05:52
jazzsequence
jazzsequence previously approved these changes Jul 13, 2023
Copy link
Contributor

@jazzsequence jazzsequence left a comment

Choose a reason for hiding this comment

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

could just use the package @v1 rather than @v1.0.2 but otherwise lgtm

@pwtyler
Copy link
Member Author

pwtyler commented Jul 13, 2023

could just use the package @v1 rather than @v1.0.2 but otherwise lgtm

tried that , I thought that would work too, but did not work. I believe we need to maintain a v1 branch or v1 tag that is updated alongside releases. Will PR that to the action(s).

@pwtyler pwtyler merged commit 9d2a8e2 into main Jul 13, 2023
2 checks passed
@pwtyler pwtyler deleted the test-readme branch July 13, 2023 21:45
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