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

feat: add github action for markdown linting #728

Closed
wants to merge 2 commits into from

Conversation

theguy147
Copy link
Collaborator

Add GitHub Action for markdown linting

Description/Motivation/Screenshots

This PR would add a GitHub Action to lint Markdown files (README.md and files in docs/). This way new contributions to GEF have to use a cleaner style for the documentation and the reviews of PR can focus more on the content rather than formatting issues and other nitpicks.

How Has This Been Tested?

Architecture Yes/No Comments
x86-32 ✖️ Replace with ✔️ if tested
x86-64 ✖️
ARM ✖️
AARCH64 ✖️
MIPS ✖️
POWERPC ✖️
SPARC ✖️
RISC-V ✖️
make test ✖️

Checklist

  • My PR was done against the dev branch, not master.
  • My code follows the code style of this project.
  • My change includes a change to the documentation, if required.
  • My change adds tests as appropriate.
  • I have read and agree to the CONTRIBUTING document.

@theguy147
Copy link
Collaborator Author

Added continue-on-error to markdown linting step so the files do get annotated but the checks can pass nonetheless.

@theguy147 theguy147 closed this Sep 28, 2021
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.

None yet

1 participant