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(readme): lint markdown and add complementary information for Mac computers with Apple Silicon #1951

Merged
merged 1 commit into from
Sep 7, 2022

Conversation

TheodoreGC
Copy link
Contributor

No description provided.

… computers with Apple Silicon

Signed-off-by: Theodore Garson <theodore.corbeaux@gmail.com>
@gweiying
Copy link
Contributor

gweiying commented Sep 6, 2022

Looks good, did you use some kind of linter to lint the markdown?

Copy link
Contributor

@gweiying gweiying left a comment

Choose a reason for hiding this comment

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

lgtm

@TheodoreGC
Copy link
Contributor Author

@gweiying

Yes, I used the markdownlint extension for VS Code. It's available here.

For a detailed definition for the rules, you can have a look there.

@TheodoreGC TheodoreGC merged commit f60f1ec into develop Sep 7, 2022
@halfwhole halfwhole deleted the feat/update-readme branch September 7, 2022 07:09
@halfwhole
Copy link
Collaborator

halfwhole commented Sep 7, 2022

linting for markdown sounds great actually! would it be a good idea to add it to our pre-commit hooks (if it's possible)?
also we favour using squash and merge as our merge strategy 🙏

@TheodoreGC
Copy link
Contributor Author

@halfwhole, That's possible indeed. You may want to check there for adding it to pre-commit hook.

Alternatively, you could check that repo for GitHub actions with broader linting possibilities.

I didn't know you were squashing and merging for your strategy. I did it locally (squashing) before pushing the changes.

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