Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Added flowcharts for algorithms #6518

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

Closed
pranjalisr wants to merge 3 commits into TheAlgorithms:master from pranjalisr:master

Conversation

Copy link

@pranjalisr pranjalisr commented Sep 4, 2025
edited
Loading

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized it.
  • All filenames are in PascalCase.
  • All functions and variable names follow Java naming conventions.
  • All new algorithms have a URL in their comments that points to Wikipedia or other similar explanations.
  • All new code is formatted with clang-format -i --style=file path/to/your/file.java

Added flowcharts for searching, sorting algorithms as of now. If this works then I will add flowcharts for other algorithms as well. issue# 6472

Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.12%. Comparing base (1393f5e) to head (a7a152d).

Additional details and impacted files
@@ Coverage Diff @@
## master #6518 +/- ##
=========================================
 Coverage 75.12% 75.12% 
 Complexity 5578 5578 
=========================================
 Files 686 686 
 Lines 19327 19327 
 Branches 3734 3734 
=========================================
 Hits 14520 14520 
 Misses 4245 4245 
 Partials 562 562 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@pranjalisr pranjalisr changed the title (削除) Added flowcharts for algorithms issue #6472 (削除ここまで) (追記) Added flowcharts for algorithms (追記ここまで) Sep 4, 2025
Copy link
Collaborator

@alxkm whats your opinion on these flowcharts? I'm honestly more a fan of animation-gifs :]

Copy link
Member

alxkm commented Sep 6, 2025

@DenizAltunkapan, I share the same view. Personally, I feel the flowcharts can be a bit confusing in this context, since the repository is about algorithm implementations. The animation GIFs seem more intuitive and informative to me as well.

Copy link
Member

alxkm commented Sep 6, 2025

@pranjalisr, Thank you for your contribution! We really appreciate the effort you’ve put into adding the flowcharts. However, since this repository is mainly focused on algorithm implementations, the flowcharts seem less suitable here. In this context, the GIFs seem to provide clearer and more useful information.

For future contributions, it might be a good idea to open an issue first, so we can discuss the proposed changes before adding them.

Copy link
Author

@alxkm , Thank you for your response! I can add animated GIFs as well and will remove the current flowchart. Should I move forward with the animated GIFs ?

Copy link
Member

alxkm commented Sep 6, 2025

@siriak, what are your thoughts on this suggestion?

Copy link
Member

siriak commented Sep 6, 2025

I think that we don't need gifs or flowcharts in this repository because it's specifically for Java implementations. Flowcharts are generic and can be in pseudocode, not in this repository. In any case, they should also be in Mermaid or PlantUML to be editable by other users and be correct.

Copy link
Collaborator

I agree with @siriak that flowcharts are not specific to Java and probably don’t belong directly in this repository.
However, I could imagine something like a separate repository under the TheAlgorithms organization – for example, Algorithms-Visualized.

That repository could collect visualizations (e.g., Mermaid flowcharts or PlantUML diagrams and GIFs) of common algorithms in a language-agnostic way. This way, learners who benefit from visual explanations would have a central place to look, while the language repos (like Java) remain focused purely on implementations.

@alxkm @siriak would you see value in such a repo or is this not worth it?

Copy link
Member

alxkm commented Sep 6, 2025

@DenizAltunkapan, I think it could be a good idea and worth discussing with the maintainers of TheAlgorithms. One thing to keep in mind is that different contributors might make diagrams in very different styles, which could be confusing. For example, one person might want to improve an existing diagram, but because of style differences it’s not clear what’s "better." Also, one explanation might work well for some learners, while another works better for others.

But again, this is more a question for the TheAlgorithms owners.

Copy link
Member

siriak commented Sep 6, 2025

I agree with @alxkm in that it can be tricky to agree on what is a good visualization. If done in a separate repo, we can also add diagrams. But there are still questions before we can start accepting contributions. Like how to visualize them. If learners come to the repository, they will see just code, not visualization. Maybe include the diagrams on the website? It requires a discussion in Discord.

alxkm and DenizAltunkapan reacted with thumbs up emoji

Copy link
Collaborator

DenizAltunkapan commented Sep 8, 2025
edited
Loading

@pranjalisr
Thanks for your effort! As mentioned earlier in the PR discussion, GIFs or flowcharts aren’t wanted in this repository. Please refer to the messages above for details.

If you’re still interested in creating such diagrams, you’d need to contact the org owners and start a discussion on the TheAlgorithms Discord.
Thank you for your understanding.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DenizAltunkapan DenizAltunkapan Awaiting requested review from DenizAltunkapan DenizAltunkapan is a code owner

@yanglbme yanglbme Awaiting requested review from yanglbme yanglbme is a code owner

@alxkm alxkm Awaiting requested review from alxkm alxkm is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /