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

qual: Format (mdformat-plugins) & Fix spelling in README.md (#95) #96

Closed
wants to merge 1 commit into from
Closed

qual: Format (mdformat-plugins) & Fix spelling in README.md (#95) #96

wants to merge 1 commit into from

Conversation

mdeweerd
Copy link
Contributor

Updated README.md to fit updated pre-commit configuration in #95 .

@Lucas-C
Copy link
Owner

Lucas-C commented Jan 15, 2024

Thank you for your contribution @mdeweerd !

I explained in #95 that I do not wish to merge this other PR, so I don't think it's necessary to fix the README.md...

Also, I'm not a big fan of having a linter telling me that I shouldn't use the word gotta...
I'm not a native English speaker, but I don't want to enforce "formal English" in my documentation.
If contributors want to use common popular abbreviations, of even be creative with neologisms and poetic sentences, I'll be happy about it and don't want an automated tool telling them that's it's not "proper English" 😅

Also, IMHO, introducing such linters on this project feels a bit like "burning CPU" on every CI pipeline execution for very limited benefits...

@mdeweerd
Copy link
Contributor Author

I am not going to discuss colors and tastes...
Words can be ignored if you gotta use them, but this will also help identify real typos to fix.
Personnally I get internally annoyed when I am working on code with typos in them - I do not care that much about gotta, but at some point one has to choose to add an exception or to match what was built into the tool.

It's up to you.

@Lucas-C
Copy link
Owner

Lucas-C commented Jan 15, 2024

Alright, thank you for sharing your opinion on this 🙂

Closing this now

@Lucas-C Lucas-C closed this Jan 15, 2024
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