fix: Issues Section #268
fix: Issues Section #268
Conversation
👷 Deploy request for docs-open pending review.Visit the deploys page to approve it
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hi @smhussain5,
Thank you for working on this! 🙌
I have left a review for you to fix. 😊
I have some points to address here. Also for your future reference, it would be best that you:
-
Read the README and Contributing Guidelines of a project before you work on your changes. And don't hesitate to ask questions if you're in doubt.
-
Always run the project locally to test the changes.
This project is built on Docusaurus. And that's the reason why your changes can't be applied here because they are alert syntax for GitHub. You will easily notice this if you've run this project locally. 🙂
-
I see that you deleted parts of the PR form. Although you might not have to fill everything, you don't want to delete/modify the template. Maintainers always review everything in the form, and often will ask to fill necessary information that contributors missed. Also, you can read the note towards the end of our form:
<!-- note: PRs with deleted sections will be marked invalid -->
That being said, I'm closing this PR.
Please create another PR, and attach a screenshot of the page with the changes rendered on your local machine.
Please let me know if you have any question/help!
Thank you.
| > [!TIP] | ||
| > If an issue is not assigned, it is assumed to be available for anyone to work on. Please assign yourself to an issue before working on it to avoid conflicts. | ||
|
|
||
| - Issues with the `needs triage` label are unavailable to `.take` until they are triaged and the label is removed. Feel free to check on the issue regularly if you want to work on it. | ||
| - If you contribute to the project for the first time, you can search for issues with `good first issue` or `bug` labels in the repository. Please only self-assign a `good first issue` one time. | ||
|
|
||
| > [!NOTE] | ||
| > Please only self-assign a `good first issue` once. | ||
|
|
There was a problem hiding this comment.
Please change the [!TIP] and [!NOTE] to what has been asked in the issue, which are :::info and :::note.
And please give proper indentation to them as what has shown in the copy in the issue.
|
Fixed in #269 |
Description
This PR addresses 2 TODO items in #249 😄
Add information about it, change the format in this section to undordered list, and adjust some wording for better read and understanding.
Capitalize the "code of conduct" term in the last paragraph.
What type of PR is this? (check all applicable)
Related Tickets & Documents
Fixes #249