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

Lint readme #100

Merged
merged 3 commits into from
Jan 6, 2023
Merged

Lint readme #100

merged 3 commits into from
Jan 6, 2023

Conversation

wolf99
Copy link
Contributor

@wolf99 wolf99 commented Dec 26, 2022

Hiya,
This PR lints the readme according to markdownlint rules.

If interested, I could add a further PR that adds a workflow that adds a markdown lint checker?

@google-cla
Copy link

google-cla bot commented Dec 26, 2022

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@wolf99
Copy link
Contributor Author

wolf99 commented Dec 26, 2022

I've attempted to add the GitHub email address (e.g. <number>+<username>@users.noreply.github.com) that is used to sign these commits, to my Google account, so that I can sign the CLA with that email address.
However the Google account settings requires alternative emails addresses to be verified. As the GitHub email address is not actually an email address as such, this is not possible.
I have signed the CLA using my personal email address but I will not be using that here due to wishing to retain my privay.

Maintainers can chose either:

  • Fix the Google account requirements for verification of alternative email addresses for services like GitHub
  • Ignore the exact details for the CLA requirement and take my word that I have signed it with my personal address and merge this PR
  • Ignore this PR

As you like 🙂

@G-Rath
Copy link
Collaborator

G-Rath commented Dec 27, 2022

Thanks - personally I think it would be best to set CI up to check this, ideally with prettier with proseWrap set to always too; is that something you'd be ok to do?

I can't speak for the CLA requirement, though I suspect it probably can't be wavered but again I'm happy to put my name against it if you're ok with that; alternatively I'm happy to handle the whole thing :)

(sorry about closing, I fat-fingered the button 😅)

@G-Rath G-Rath closed this Dec 27, 2022
@G-Rath G-Rath reopened this Dec 27, 2022
@oliverchang
Copy link
Collaborator

Looks like the CLA is passing now! Thanks for contribution @wolf99.

@oliverchang
Copy link
Collaborator

/gcbrun

@oliverchang oliverchang merged commit d05e800 into google:main Jan 6, 2023
@wolf99 wolf99 deleted the lint-readme branch January 9, 2023 20:10
wolf99 added a commit to wolf99/osv-scanner that referenced this pull request Jan 12, 2023
Becuase they've *alread* got lint issues since PR google#100
julieqiu pushed a commit to julieqiu/osv-scanner that referenced this pull request May 2, 2023
* Basic syntactical lint

* Fix consoel code blocks

Co-authored-by: Oliver Chang <[email protected]>
julieqiu pushed a commit to julieqiu/osv-scanner that referenced this pull request May 2, 2023
* Basic syntactical lint

* Fix consoel code blocks

Co-authored-by: Oliver Chang <[email protected]>
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