Skip to content

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

Merged
merged 15 commits into from
Oct 23, 2024
Merged

Update CONTRIBUTING.md #1365

merged 15 commits into from
Oct 23, 2024

Conversation

UTSAVS26
Copy link
Contributor

Pull Request Summary

This pull request enhances the contribution guide for the cp-algorithms project by improving clarity, readability, and structure. Key changes include:

  • Clearer steps for contributing, making the process more accessible for new contributors.
  • Improved organization of sections, with distinct headings for different topics.
  • Expanded explanations of Markdown syntax and article conventions to facilitate better contributions.
  • Added friendly and inclusive language to encourage community participation.

These improvements aim to streamline the contribution process and foster a welcoming environment for all contributors.

@adamant-pwn
Copy link
Member

adamant-pwn commented Oct 15, 2024

Hi Utsav, thanks for the pull request! Could you please tell, is this AI generated?

@UTSAVS26
Copy link
Contributor Author

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.

Copy link
Member

@adamant-pwn adamant-pwn left a 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
```
Copy link
Member

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.

Copy link
Member

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...

@UTSAVS26
Copy link
Contributor Author

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 🙂

Yeh sure, I will make necessary changes and update you when it's done. Thank you for your time. ☺️

@UTSAVS26
Copy link
Contributor Author

@adamant-pwn updated the files based on review requested. Please review and suggest changes if comes. Thank you.

@UTSAVS26
Copy link
Contributor Author

@adamant-pwn done.

@adamant-pwn
Copy link
Member

Thanks! But please note that I have re-opened some conversations.

@UTSAVS26
Copy link
Contributor Author

Thanks! But please note that I have re-opened some conversations.

Yes I have checked them and updated it.

@adamant-pwn
Copy link
Member

Can you please check once again? Because some of them are still not fixed...

@UTSAVS26
Copy link
Contributor Author

Can you please check once again? Because some of them are still not fixed...

Okie i will check and update you.

Copy link
Member

@adamant-pwn adamant-pwn left a 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...

@adamant-pwn adamant-pwn merged commit a3ae3e8 into cp-algorithms:main Oct 23, 2024
3 checks passed
github-actions bot added a commit that referenced this pull request Oct 23, 2024
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