-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Update CONTRIBUTING.md #1365
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
Update CONTRIBUTING.md #1365
Conversation
Hi Utsav, thanks for the pull request! Could you please tell, is this AI generated? |
Thanks so much for checking out my pull request! Just to clarify, this contribution isn’t AI-generated. I like to jump in and help out with documentation whenever I see something that could be improved. I really believe that better docs can make it easier for new contributors to get involved. I've done similar updates in other repos like Llmware and Taipy, where I tried to make the documentation friendlier and more helpful. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the pull request! I think, overall it's a significant improvement, but I have some questions that should be addressed. Hope we will merge this afterwards 🙂
CONTRIBUTING.md
Outdated
|
||
```{.cpp file=snippet-name} | ||
// some code | ||
// code here | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This code block omits the first and the third line in the preview that it is supposed to show, apparently because now it is a part of the numerated list. Please find a way to fix this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you resolve this? It's still not fixed...
Yeh sure, I will make necessary changes and update you when it's done. Thank you for your time. |
@adamant-pwn updated the files based on review requested. Please review and suggest changes if comes. Thank you. |
@adamant-pwn done. |
Thanks! But please note that I have re-opened some conversations. |
Yes I have checked them and updated it. |
Can you please check once again? Because some of them are still not fixed... |
Okie i will check and update you. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, I think that's all the changes that were necessary. Thanks, I think it actually does improve the style and makes it better structured. Although some of your responses really seemed AI generated, and marking some conversations as resolved without actually doing fixing them wasn't good, please don't do this in the future...
Pull Request Summary
This pull request enhances the contribution guide for the cp-algorithms project by improving clarity, readability, and structure. Key changes include:
These improvements aim to streamline the contribution process and foster a welcoming environment for all contributors.