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

[improvement] update README with more details than a stub #914

Merged
merged 13 commits into from
Jun 28, 2020

Conversation

kvedala
Copy link
Collaborator

@kvedala kvedala commented Jun 26, 2020

Description of Change

Checklist

  • Added description of change
  • Added file name matches File name guidelines
  • Added tests and example, test must pass
  • Added documentation so that the program is self-explanatory and educational - Doxygen guidelines
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • I acknowledge that all my contributions will be made under the project's license.

Notes:

@kvedala kvedala added the Improvement improvement in previously written codes label Jun 26, 2020
Signed-off-by: Krishna Vedala <[email protected]>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

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

As-is, everything seems to be fine. 🙂

README.md Outdated Show resolved Hide resolved
@kvedala
Copy link
Collaborator Author

kvedala commented Jun 26, 2020

Thank you guys for the inputs.
Note that a readme file is an assertive info document not a guideline. I will accept some of the suggestions made above.

@kvedala
Copy link
Collaborator Author

kvedala commented Jun 27, 2020

@cclauss there were some suggestions you made. I do not see them anymore

@mishraabhinn
Copy link
Member

Authors and acknowledgment
We can share appreciation to those who have contributed to the project.
Contributers

@mishraabhinn
Copy link
Member

Authors and acknowledgment
We can share appreciation to those who have contributed to the project.
Contributers

Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

@kvedala
Copy link
Collaborator Author

kvedala commented Jun 27, 2020

Authors and acknowledgment
We can share appreciation to those who have contributed to the project.
Contributers

Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

For open source repositories, I have not seen what you mentioned. Can you show me other open source repos that have their README as you suggested?

@mishraabhinn
Copy link
Member

Authors and acknowledgment
We can share appreciation to those who have contributed to the project.
Contributers

Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

For open source repositories, I have not seen what you mentioned. Can you show me other open source repos that have their README as you suggested?

I thought this point.
https://github.com/OpenGenus/cosmos this repo has a contributors list.

@kvedala
Copy link
Collaborator Author

kvedala commented Jun 27, 2020

Every repository has a contributors list: https://github.com/TheAlgorithms/C-Plus-Plus/graphs/contributors
I doubt if we need to create yet another list , a wiki, etc. They don't really add to the repo value. The individual contributors names/github userid are provided within the C++ files themselves.

@kvedala kvedala merged commit c7088b4 into TheAlgorithms:master Jun 28, 2020
@kvedala kvedala deleted the update_README branch June 28, 2020 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement improvement in previously written codes ready for review
Projects
None yet
5 participants