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

Add Markdown linter #386

Merged
merged 7 commits into from
Mar 24, 2022
Merged

Add Markdown linter #386

merged 7 commits into from
Mar 24, 2022

Conversation

fenogentov
Copy link
Contributor

@fenogentov fenogentov commented Mar 23, 2022

Closes #64.

@fenogentov fenogentov requested a review from AlekSi as a code owner March 23, 2022 09:52
@CLAassistant
Copy link

CLAassistant commented Mar 23, 2022

CLA assistant check
All committers have signed the CLA.

@codecov
Copy link

codecov bot commented Mar 23, 2022

Codecov Report

Merging #386 (4fcf69b) into main (0ec1502) will not change coverage.
The diff coverage is n/a.

❗ Current head 4fcf69b differs from pull request most recent head 24636eb. Consider uploading reports for the commit 24636eb to get more accurate results

@@           Coverage Diff           @@
##             main     #386   +/-   ##
=======================================
  Coverage   49.28%   49.28%           
=======================================
  Files         114      114           
  Lines        5440     5440           
=======================================
  Hits         2681     2681           
  Misses       2323     2323           
  Partials      436      436           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0e8b282...24636eb. Read the comment docs.

@AlekSi
Copy link
Member

AlekSi commented Mar 23, 2022

Please click the CLA button to sign our CLA.

Copy link
Member

@AlekSi AlekSi left a comment

Choose a reason for hiding this comment

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

A great start!

* Add more metrics by @AlekSi in https://github.com/FerretDB/FerretDB/pull/298
* Implement `$size` query operator by @taaraora in https://github.com/FerretDB/FerretDB/pull/296

* Support projections by @ekalinin in <https://github.com/FerretDB/FerretDB/pull/212>
Copy link
Member

Choose a reason for hiding this comment

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

This file is generated automatically: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

Is it possible to automatically fix it with --fix flag? If not, can we skip it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Flag --fix automatic fixing of some problems. But not everyone.
Without it, we will get a list of warnings for self-correction.

It is also possible to add configuration and disable some rules.

Copy link
Member

Choose a reason for hiding this comment

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

Did you chnage this file manually, or --fix did everything? If yes, great! If not, we should skip that file,

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is changed automatically when flag --fix
We do not need to skip file, we can disable individual rules

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we can configure according to our rules.
for example

# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
MD022:
  # Blank lines above heading
  lines_above: 1
  # Blank lines below heading
  lines_below: 1

Copy link
Member

Choose a reason for hiding this comment

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

That sounds useful, but what about those changes with URLs (added < and >)?

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Now this rule is disabled in the configuration

Taskfile.yml Outdated Show resolved Hide resolved
@AlekSi
Copy link
Member

AlekSi commented Mar 23, 2022

Please click that button if PR is ready for re-review:
image

@fenogentov fenogentov requested a review from AlekSi March 24, 2022 02:15
Copy link
Member

@AlekSi AlekSi left a comment

Choose a reason for hiding this comment

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

@AlekSi AlekSi added the code/chore Code maintenance improvements label Mar 24, 2022
@AlekSi AlekSi added this to the v0.0.7 milestone Mar 24, 2022
@AlekSi AlekSi merged commit 6abe71c into FerretDB:main Mar 24, 2022
@AlekSi
Copy link
Member

AlekSi commented Mar 24, 2022

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code/chore Code maintenance improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Markdown linter
3 participants