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

Implement codespell as a workflow #1554

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Conversation

Frierened
Copy link

#1527 follow up

I have no admit it's my first time doing that, so please check

@CLAassistant
Copy link

CLAassistant commented Dec 15, 2023

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator

@xgreenx xgreenx left a comment

Choose a reason for hiding this comment

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

Thank you for the PR! It's funny that PR is created by another person(not original one) with a private profile=)

Hmm, why it doesn't include files from the original PR?

.codespellrc Outdated Show resolved Hide resolved
@Frierened
Copy link
Author

I'm not the original poster, it's been more than two weeks so I figured I would try to implement it myself.
My profile is private because it's easily doxxable.

As I'm not the original poster, I started back from scratches, that's why I missed some errors from the original PR.

Updated much of it now, should be better. LMK

@xgreenx xgreenx added the no changelog Skip the CI check of the changelog modification label Dec 18, 2023
run: pip install codespell

- name: Run codespell
run: codespell
Copy link
Collaborator

Choose a reason for hiding this comment

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

It will not fail the CI if we have some spelling mistakes. Could you also apply suggestions from codespell to the whole codebase, please?

Copy link
Author

Choose a reason for hiding this comment

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

Added codespell to CI, should fail if there are spelling mistakes (exit error 65).

Could you also apply suggestions from codespell to the whole codebase, please?

Sure, do you mean every repos of FuelLabs?

Copy link
Collaborator

@xgreenx xgreenx Dec 20, 2023

Choose a reason for hiding this comment

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

I meant to fuel-core. I tried to run codespell locally, and it seems to produce a lot of warnings.

Nevermind, I forgot to use your configuration

xgreenx
xgreenx previously approved these changes Dec 20, 2023
.github/workflows/ci.yml Outdated Show resolved Hide resolved
xgreenx
xgreenx previously approved these changes Dec 20, 2023
Copy link
Collaborator

@xgreenx xgreenx left a comment

Choose a reason for hiding this comment

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

Another thing to consider is that the original PR had more suggestions, so maybe we can use something more advanced to fix spelling.

@Frierened
Copy link
Author

Another thing to consider is that the original PR had more suggestions, so maybe we can use something more advanced to fix spelling.

It's certainly AI-related as it also identifies missing articles. I doubt it to be open-source, I guess it's a homemade script using some model's API.
I hopefully resolved conflicts. Have a nice Christmas.

@xgreenx xgreenx mentioned this pull request Feb 15, 2024
This was referenced Feb 26, 2024
This was referenced Mar 6, 2024
@xgreenx xgreenx mentioned this pull request Mar 18, 2024
@sdankel sdankel mentioned this pull request May 8, 2024
5 tasks
xgreenx pushed a commit that referenced this pull request May 13, 2024
Related #1554

Adds a CI check for typos and fixes all* typos in code, comments, and
docs.

*found by [typos-cli](https://github.com/crate-ci/typos)

## Checklist
- [ ] Breaking changes are clearly marked as such in the PR description
and changelog
- [ ] New behavior is reflected in tests
- [ ] [The specification](https://github.com/FuelLabs/fuel-specs/)
matches the implemented behavior (link update PR if changes are needed)

### Before requesting review
- [x] I have reviewed the code myself
- [ ] I have created follow-up issues caused by this PR and linked them
here

### After merging, notify other teams

None
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog Skip the CI check of the changelog modification
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants