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 GitHub quality check action: The starting letters should match #107

Open
1 of 3 tasks
koppor opened this issue Sep 2, 2022 · 4 comments
Open
1 of 3 tasks

Add GitHub quality check action: The starting letters should match #107

koppor opened this issue Sep 2, 2022 · 4 comments

Comments

@koppor
Copy link
Member

koppor commented Sep 2, 2022

The action should check:

@AkshatJain9
Copy link
Contributor

AkshatJain9 commented Oct 15, 2022

Hi, its me again,

I've added a basic python script in my fork which runs every time the main branch is pushed to, and checks if any ampersands are escaped. I have done this using GitHub actions as suggested.

The current result of this follows;
image

(Noting the error was not added by me, seems like we do in fact have an escaped ampersand in the repo)

My question is, what else needs to be done? Do we want the csv to be automatically edited in this case to replace the \& with &? Would it be more helpful if I add the specific line and column of the escaped ampersand to the error?

Thanks for your patience in advance :)

@Siedlerchr
Copy link
Member

Thanks for your script, I would say column and line number reporting is the best way to go forward. Followed by a manual editing then
Automatic fixing could have some side effects.

@AkshatJain9
Copy link
Contributor

Hi, I've updated the script so that now, it returns all the locations of all escaped ampersands, instead of just failing on the first one found. This has been tested locally with multiple escaped ampersands across multiple files.

I have also amended the erroneous csv file. Aside from the small formatting error, I was wondering if this was ready for a code review/draft pull request. I have currently worked on my main branch so as to simulate how GitHub actions will execute the script in actuality, but I can transfer this over to a feature branch if needed.

Any other feedback is also appreciated, thanks!

@koppor
Copy link
Member Author

koppor commented Nov 2, 2022

@AkshatJain9 you implemented "Each abbreviation should not contain &"

The check for "the starting letters should match somehow" is still missing. I don't know, how easy this is.

@koppor koppor changed the title Add GitHub quality check action Add GitHub quality check action: The starting letters should match Feb 27, 2023
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

No branches or pull requests

3 participants