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

docs: update README.md #1934

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

famouswizard
Copy link

Fix Typo in Directory Path: ts/utls/ts/utils/

Summary:
This PR fixes a minor typo in the directory path from ts/utls/ to ts/utils/. The original spelling "utls" is incorrect, and the correct term is "utils", which is short for "utilities."

Importance:
This fix is crucial for ensuring the clarity and consistency of the project. The typo could confuse developers who are unfamiliar with the directory structure or lead to potential issues if they try to reference a non-existent directory. Correcting it will improve the overall readability of the documentation and prevent possible errors in the future.

Confirmation

Fix Typo in Directory Path: ts/utls/ → ts/utils/
Copy link

vercel bot commented Nov 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
maci-website ✅ Ready (Inspect) Visit Preview Nov 13, 2024 9:09am

Copy link
Collaborator

@ctrlc03 ctrlc03 left a comment

Choose a reason for hiding this comment

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

Thanks, please ensure that the commit message respects these guidelines https://maci.pse.dev/docs/contributing/#commits-rules

@ctrlc03 ctrlc03 mentioned this pull request Nov 20, 2024
3 tasks
@famouswizard
Copy link
Author

Thanks, please ensure that the commit message respects these guidelines https://maci.pse.dev/docs/contributing/#commits-rules

It is.

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Nov 22, 2024

Thanks, please ensure that the commit message respects these guidelines https://maci.pse.dev/docs/contributing/#commits-rules

It is.

it is not, please check here: https://github.com/privacy-scaling-explorations/maci/actions/runs/11814015638/job/32912236798?pr=1934

@famouswizard
Copy link
Author

famouswizard commented Nov 23, 2024

ts/utls/

That's very strange because you don't even have a ts/utls/ folder.

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Nov 23, 2024

ts/utls/

That's very strange because you don't even have a ts/utls/ folder.

I'm not sure what you are referring to here. The reason why this PR cannot be merged as is, is because your commit message does not follow the commit rules. This is your commit message: "Typo Update README.md", instead it should be something like: "docs: update README.md"

@famouswizard famouswizard changed the title Typo Update README.md docs: update README.md Nov 23, 2024
@famouswizard
Copy link
Author

ts/utls/

That's very strange because you don't even have a ts/utls/ folder.

I'm not sure what you are referring to here. The reason why this PR cannot be merged as is, is because your commit message does not follow the commit rules. This is your commit message: "Typo Update README.md", instead it should be something like: "docs: update README.md"

You are right, I edited the topic.

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Nov 23, 2024

ts/utls/

That's very strange because you don't even have a ts/utls/ folder.

I'm not sure what you are referring to here. The reason why this PR cannot be merged as is, is because your commit message does not follow the commit rules. This is your commit message: "Typo Update README.md", instead it should be something like: "docs: update README.md"

You are right, I edited the topic.

you need to edit your commit message not the title of the PR. Please read here for instructions: https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message

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