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

[FEATURE] : added /impl directory for algorithms implementation and other utility Go programs. #5172

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

pacifiquem
Copy link

This is special pull request which does things that we're discussed on in pacifiquem/awesome-go#45 by me (@pacifiquem) and Maintainer (@avelino).

What I covered:

  • I added /impl directory which contains implementation of algorithms and other utility programs that are written in Go
  • Added contribution guidelines for that subdirectory
  • Updated README accordingly

Check Boxes:

  • The package has been added to the list in alphabetical order.
  • The package has an appropriate description with correct grammar.
  • As far as I know, the package has not been listed here before.
  • The repo documentation has a coverage service link.
  • I have read the Contribution Guidelines, Maintainers Note and Quality Standards.
  • The repo has a continuous integration process that automatically runs tests that must pass before new pull requests are merged.
  • Continuous integration is used to attempt to catch issues prior to releasing this package to end-users.

Important

Feel free to ask for improvements where they're need in order to get this PR marged

This comment was marked as resolved.

Copy link
Owner

@avelino avelino left a comment

Choose a reason for hiding this comment

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

the tests are breaking, we will probably have to organize the directory names, we install the Go packages with go get ./... to recursively download the packages

go: github.com/avelino/awesome-go/impl/algorithms/Data Structures: malformed import path "github.com/avelino/awesome-go/impl/algorithms/Data Structures": invalid char ' '
go: github.com/avelino/awesome-go/impl/algorithms/Dynamic Programming: malformed import path "github.com/avelino/awesome-go/impl/algorithms/Dynamic Programming": invalid char ' '
go: github.com/avelino/awesome-go/impl/algorithms/Greedy Algorithms: malformed import path "github.com/avelino/awesome-go/impl/algorithms/Greedy Algorithms": invalid char ' '
Error: Process completed with exit code 1.

we need to generate static pages for each algorithm for awesome-go.com, enabling search engines to index (SEO, aka Google), I haven't identified this implementation

@pacifiquem
Copy link
Author

pacifiquem commented Jan 20, 2024

I'm going to tryna fix all issues related to tests and Static Code Analysis, I'll be back on that topic of static pages generation for each algorithm on awesome-go.com later.

@pacifiquem
Copy link
Author

My perspective about generating static pages for each algorithm is that although generating static pages for each algorithm on awesome-go.com could be beneficial for SEO purposes, it may not be the most practical solution. Currently, with all tests passing, I suggest maintaining the current approach of directing users to GitHub for the algorithm implementations. This allows users to scroll through the implementation section on awesome-go.com, choose the algorithm of interest, and be redirected to the corresponding GitHub file. Displaying code directly on the website would necessitate creating descriptions for each algorithm, which could be cumbersome. Instead, I propose adding comments at the beginning of each file on GitHub to provide concise explanations of what the algorithm does and how it works. This keeps the user experience seamless, avoids unnecessary duplication of information, and encourages engagement with the actual code on GitHub for a more interactive and efficient exploration of the implementations.

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