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

Polish docs #1603

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

Polish docs #1603

wants to merge 1 commit into from

Conversation

izeye
Copy link

@izeye izeye commented Apr 4, 2025

What kind of change does this PR introduce?

This PR adds a missing ending colon in the basics.md.

Issue Number:
N/A

Screenshots/videos:

N/A

If relevant, did you update the documentation?

N/A

Summary

N/A

Does this PR introduce a breaking change?

N/A

Checklist

Please ensure the following tasks are completed before submitting this pull request.

@izeye izeye requested a review from a team as a code owner April 4, 2025 07:52
@jagpreetrahi
Copy link
Contributor

Hey @izeye , cau you please provide more detail about this PR , not able to understand what you're trying to resolve.

@izeye
Copy link
Author

izeye commented Apr 5, 2025

@jagpreetrahi It's just a missing punctuation mark between the sentence and the next code block like the following in the same Markdown file:

This accepts anything, as long as it's valid JSON:
```json
// props { "isSchema": true }
true
```

@jagpreetrahi
Copy link
Contributor

Can you please mention the issue number also

@izeye
Copy link
Author

izeye commented Apr 6, 2025

@jagpreetrahi I didn't create an issue for it. I'm not sure if it's worth it as it's just a small and obvious fix.

@jagpreetrahi
Copy link
Contributor

@izeye , as we begin contributing, it's natural to feel excited to merge PRs. However, the standard practice is to first create an issue (if one doesn't already exist), wait for it to be accepted, and then open a PR. This approach helps maintain clarity and coordination within the project.
If you're new here, I recommend reading the contribution guidelines and the code of conduct first. It's important to follow the proper process when making a PR. Even if the issue seems small, it's still best to create an issue first.
I hope you understand and will follow the standard contribution flow moving forward.

Thanks

@izeye
Copy link
Author

izeye commented Apr 6, 2025

@jagpreetrahi I just created this PR through the "Edit this page on Github" link on the website, so I hoped it's okay as-is.

Thanks for the feedback, but I'll wait for maintainers' feedback as I don't want to make any more noise here due to this small fix.

@izeye izeye changed the title Add a missing ending colon in basics.md Polish docs Apr 9, 2025
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