Skip to content

[skip changelog] Introduce linting and formatting for docs and config files #836

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

Merged
merged 11 commits into from
Jul 21, 2020
Merged

[skip changelog] Introduce linting and formatting for docs and config files #836

merged 11 commits into from
Jul 21, 2020

Conversation

silvanocerza
Copy link
Contributor

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Created new tasks to run linting and formatting on documentation and config files, Markdown and YAML files only for now.
Created Workflow to check linting of Markdown and YAML files.
Updated contributing documentation with linting and formatting instructions.
Formatted all Markdown and YAML files with newly introduced formatting configuration.

@silvanocerza
Copy link
Contributor Author

silvanocerza commented Jul 17, 2020

I suggest you skip a6cceab [skip changelog] Format all docs and config files since they're only formatting changes.

@rsora rsora requested a review from per1234 July 17, 2020 11:26
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

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

This is really great @silvanocerza. Thanks!

I have asked for clarification on a few things. I also pointed out some places where the automatic formatting will cause issues, but I think this can be resolved.

@silvanocerza silvanocerza merged commit 02416e7 into arduino:master Jul 21, 2020
@silvanocerza silvanocerza deleted the docs-config-formatting branch July 21, 2020 13:37
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