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

feat(workflows): Enable code spellchecking #947

Draft
wants to merge 1 commit into
base: staging
Choose a base branch
from

Conversation

craciunoiuc
Copy link
Member

@craciunoiuc craciunoiuc commented Oct 27, 2023

Prerequisite checklist

  • Read the contribution guidelines regarding submitting new changes to the project;
  • Tested your changes against relevant architectures and platforms;
  • Ran make fmt on your commit series before opening this PR;
  • Updated relevant documentation.

Description of changes

This one is for you @nderjung

If we want this to work properly we need to add some custom dictionaries to make sure that words like unikraft and kraftkit, etc. are caught

We can add single exceptions, but I think it warrants a dictionary. Examples:
https://github.com/check-spelling/check-spelling/wiki/Feature:-Area-dictionaries

We should not merge until then

@craciunoiuc craciunoiuc added kind/enhancement New feature or request area/.github/workflows Issue or PR related to GitHub Actions workflows labels Oct 27, 2023
@nderjung
Copy link
Member

Thanks 😇 But is this not already enabled via golangci-lint ?

@craciunoiuc craciunoiuc force-pushed the craciunoiuc/enable-spellcheck branch 2 times, most recently from d95497b to c9f5265 Compare October 27, 2023 12:28
Signed-off-by: Cezar Craciunoiu <cezar.craciunoiu@unikraft.io>
@craciunoiuc
Copy link
Member Author

I think that is for variables only? Comments are for sure ommited.

Anyways, this is just an idea right now, they don't really say how this should be structured so I just tried some things

@craciunoiuc
Copy link
Member Author

Converting to draft cause it doesn't really work, also is not that urgent

@craciunoiuc craciunoiuc marked this pull request as draft December 19, 2023 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/.github/workflows Issue or PR related to GitHub Actions workflows kind/enhancement New feature or request
Projects
Status: 🧊 Icebox
Development

Successfully merging this pull request may close these issues.

None yet

2 participants