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

Remove broken code in readme files. (python, cpp, c#, java, etc) #547

Open
shhossain opened this issue Oct 28, 2022 · 28 comments · Fixed by #561, #556 or #554
Open

Remove broken code in readme files. (python, cpp, c#, java, etc) #547

shhossain opened this issue Oct 28, 2022 · 28 comments · Fixed by #561, #556 or #554
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@shhossain
Copy link
Owner

Remove broken code

Lots of broken code in the algorithm folder.

Test the code on readme files and remove those that are not working.

@shhossain shhossain added bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed labels Oct 28, 2022
@jhuynh06
Copy link
Contributor

Can I be assigned to this issue? Thank you!

@shhossain
Copy link
Owner Author

@jhuynh06 Sure

@shhossain
Copy link
Owner Author

The issue is still open as their is lots of broken code.

@Technic143
Copy link
Contributor

Dear colleagues, I very new at GitHub. But ready to contribute to solve the issues. Can you explain how can I find non-working code in readme files to fix?

@shhossain
Copy link
Owner Author

shhossain commented Nov 7, 2022

fork the repository in your local machine and check for codes in readme files. And test the code in a online compiler or local computer if you have that language installed in your machine. And if a code is not running properly you can do two things if you can fix the error fix it and remove it if you can't and submit a pr(pull request). @Technic143

@Technic143
Copy link
Contributor

OK thanks.
Check my understanding please (I already forked the repository).
Now I can download readme files from the repository, check them with local Markdown editor and correct. Correct?

@Technic143
Copy link
Contributor

P.S. I have some knowledge in Python. Some readme files use this correct?

@shhossain
Copy link
Owner Author

@Technic143 yes

@Technic143
Copy link
Contributor

Hello! I corrected: M Colouring Problem\readme.md via PyCharm and pushed this. Can you check did I do it correctly, can you use this?

@shhossain
Copy link
Owner Author

You have to create a PUll request. @Technic143

@Technic143
Copy link
Contributor

I did it in PyCharm, and Pull request was sent to GitHub. Or nevertheless I have to repeat this on GitHub?

@Technic143
Copy link
Contributor

sorry, Pull is not Push,,,

@Technic143
Copy link
Contributor

I did, correct?

@shhossain
Copy link
Owner Author

@Technic143 merged.

@Technic143
Copy link
Contributor

OK see thanks!

@shhossain
Copy link
Owner Author

@Technic143 welcome.

@Technic143
Copy link
Contributor

Hello! Is it necessary to correct small typos like comma instead dot or one letter misprint of word in the readme?

@shhossain
Copy link
Owner Author

Yes. You can fix any typos. Small or big. @Technic143

@Technic143
Copy link
Contributor

Hello! Found, that in 0/1 Knapsack Problem chapter Readme file, Python code doesn't work, an error appears. The program is without any comments - this is not easy to check. Is it necessary to find the mistake in the code or maybe find another code in the internet? Or I can try to create own code for the task, what do you think?

@shhossain
Copy link
Owner Author

@Technic143 you can fix the code any way you want.

@Technic143
Copy link
Contributor

Tried to pull the corrections, but c# code is failure. I corrected only Python. Don't know how to proceed.

@shhossain
Copy link
Owner Author

@Technic143 no problem. Test don't support c#.

@TsiG-404
Copy link
Contributor

Hi i saw that in buble sort it doesnt have an example in c# can add an exmple code ?

@shhossain
Copy link
Owner Author

@TsiG-404 sure.

@TsiG-404
Copy link
Contributor

Ok thanks i added the code

@adkbbx
Copy link

adkbbx commented Sep 26, 2023

Hey there,
I'm intrested in contributing to this issue do let me know how I can help

@shhossain
Copy link
Owner Author

@adkbbx you can add a new section, update or improve the existing readme.

@MarcusW03
Copy link
Contributor

#770

Updated formatting for Sorting Methods documentation in the readme's. Also fixed some typos and errors I found.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
6 participants