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 codespell support (config, workflow to detect/not fix) and make it fix few typos #603

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

yarikoptic
Copy link

Again, great talk at INCF 2024 @dickscheid ! Amazing scale of endeavors. Need to try siibra-python and see how we could integrate your online options with our external servicing for https://dandiarchive.org/ . Let's chat more while in the same room ;)

Meanwhile - my humble contribution to siibra is this PR.
More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

…(but ignoring overall fail due to ambigous ones)

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w || :",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 2",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@xgui3783
Copy link
Member

xgui3783 commented Oct 8, 2024

Dear @yarikoptic ,

Thank you for your interest in siibra-python.

We are in the middle of a large refactor at the moment. I would imagine your PR would almost certainly cause merge conflicts.

We understand your time is precious, and would thus like to offer to implement codespell once refactor is stable, and attribute you as a co-contributor[1].

If you would prefer to create new PR/commits once refactor becomes stable, we can also offer to ping you when that is the case (if this is the case, please let us know in this issue).

In either case, we will keep this PR open until it is resolved in one of the two ways above.

[1] https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors

@yarikoptic
Copy link
Author

Whatever works for you. Ping be whenever

@AhmetNSimsek
Copy link
Collaborator

Dear @yarikoptic,
We will merge this PR in version 1 after all. (This will be done just before we release v1.0.0-alpha.) Just wanted to update you on the matter.
Thanks again!

@yarikoptic
Copy link
Author

coolio.
ping me whenever you want/ready for me to rebase/rerun fixup of typos so we avoid conflicts (unless you want to just merge and resolve yourself).

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.

3 participants