microsoft / nnfusion

A flexible and efficient deep neural network (DNN) compiler that generates high-performance executable from a DNN model description.
MIT License
958 stars 162 forks source link

[Typo] An automatic github action solution for typo inspection. #416

Closed LeiWang1999 closed 2 years ago

LeiWang1999 commented 2 years ago

An automatic github action solution for typo inspection.

Description

Refer to this comment, inspection for spelling is a trouble work, this pr gives a github action solution.

This pull request takes insight from microsoft terminal repo, issue 4473, github action check-spelling, we use the latest released version 0.0.19(the same version used in microsoft terminal).

And a macos .DS_Store gitignore addition.

Type of change

How Has This Been Tested?

I made a private repository to test the github action workload, check-spelling will work on both stage of pull request and push.

Future work

I created a bit of white list to cover some simple words, for example, nnfusion, microsoft.etc . But it's quite a dirty work! The unrecognized words in nnfusion is not a little (the dictionary will have about 1000 words? I guess), maybe we need some volunteers to cover this work.

LeiWang1999 commented 2 years ago

Test pull request and currently unrecognized words can be reviewed at intentional typo.

words' location can be found at action runs

LeiWang1999 commented 2 years ago

Please CC @wenxcs

wenxcs commented 2 years ago

/azp run

azure-pipelines[bot] commented 2 years ago
Azure Pipelines successfully started running 1 pipeline(s).
LeiWang1999 commented 2 years ago

/azp run

azure-pipelines[bot] commented 2 years ago
Commenter does not have sufficient privileges for PR 416 in repo microsoft/nnfusion
LeiWang1999 commented 2 years ago

Now I had tried my best to fix the typo of nnfusion, a lot of words are append to the whitelist and a lot of words are fixed. The Github Action bot can work well. It's tested in this pr.

Please CC @wenxcs

xysmlx commented 2 years ago

/azp run

azure-pipelines[bot] commented 2 years ago
Azure Pipelines successfully started running 1 pipeline(s).