Skip to content

Conversation

@prathikkaranth
Copy link
Contributor

@prathikkaranth prathikkaranth commented May 15, 2025

Fixes #116

@feltech
Copy link
Member

feltech commented May 15, 2025

Thanks for this! The changes look good, just a couple of issues with the commit itself.

  • GitHub is configured to require commits to be GPG signed. This will involve generating a GPG key on your PC, uploading the public key to GitHub, configuring git to sign commits using the private key, amending the commit, and force-pushing - see linked GitHub docs for more info, and reach out on Slack if struggling. This is a common requirement of many open source projects, so its worth setting up.
  • Please format the commit message according to the commit message guidelines. In this case something like

[Docs] Correct notebook FilePathUrlConverter -> FileUrlPathConverter

Closes #116.

Correct class name in Jupyter Notebook from FilePathUrlConverter to
FileUrlPathConverter.

I.e. add the [Docs] component, add a reference to the issue, and keep below 72 chars. The guidelines do say "Titles should be no more than 50 characters", but in practice that's often too difficult, so it's more an aspiration. But do keep below 72 chars.

Thanks again!

@prathikkaranth prathikkaranth changed the title [Fix] Correct class name from FilePathUrlConverter to `FileUrlPathC… [Docs] Correct notebook FilePathUrlConverter -> FileUrlPathConverter May 15, 2025
Closes OpenAssetIO#116.

Correct class name in Jupyter Notebook from FilePathUrlConverter to
FileUrlPathConverter.

Signed-off-by: prathik <[email protected]>
@prathikkaranth
Copy link
Contributor Author

My bad, should've read the commit guidelines. I've pushed the new changes, let me know if they're fine now.

Thanks!

Copy link
Member

@feltech feltech left a comment

Choose a reason for hiding this comment

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

Great, thanks! 🥳

@feltech feltech merged commit d58a7da into OpenAssetIO:main May 15, 2025
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

FileUrlPathConverter misspelled in Jupyter Notebook

3 participants