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

Help needed for selecting catogory #58

Closed
Dawny33 opened this issue Mar 7, 2016 · 8 comments
Closed

Help needed for selecting catogory #58

Dawny33 opened this issue Mar 7, 2016 · 8 comments

Comments

@Dawny33
Copy link

Dawny33 commented Mar 7, 2016

I think my package: Algorithms.jl would make good addition to the existing list of packages.

This included the implementation of algorithms used for competitive programming and competitive data science.

So, can someone suggest a category which suits the package, so that I can go forward and send a PR.

@svaksha
Copy link
Owner

svaksha commented Mar 7, 2016

Hello,

Thanks for asking.

On Mon, Mar 7, 2016 at 7:21 AM, Jalem Raj Rohit
notifications@github.com wrote:

I think my package: Algorithms.jl would make good addition to the existing list of packages.

This included the implementation of algorithms used for competitive programming and competitive data science.

So, can someone suggest a category which suits the package, so that I can go forward and send a PR.

You may want to consider using a more descriptive name in line with
the Julia package naming conventions:
http://docs.julialang.org/en/release-0.4/manual/packages/#guidelines-for-naming-a-package
"Algorithms" is a vast term, so if you are implementing specific kinds
of algorithms (say, for data science) its better to have a more
specific and descriptive name as the more common sorting and searching
algorithms are already implemented in base. Also, Images.jl (in
Metadata) also has a module with the same name and there is
https://github.com/cfusting/algorithms.jl but this is probably not in
Metadata.

Best,
SVAKSHA ॥ http://about.me/svaksha

@Dawny33
Copy link
Author

Dawny33 commented Mar 7, 2016

You may want to consider using a more descriptive name

Yeah, but I chose the name to be easily searchable by newcomers, so maybe I'll stick with it. (However, I'll probably change it's name for a more clear and easy one later!). Thanks for the suggestion.

"Algorithms" is a vast term, so if you are implementing specific kinds
of algorithms (say, for data science) its better to have a more
specific and descriptive name as the more common sorting and searching
algorithms are already implemented in base. Also, Images.jl (in
Metadata) also has a module with the same name and there is
https://github.com/cfusting/algorithms.jl but this is probably not in
Metadata.

I see that(but not sure) the repo in the second link isn't being actively developed. However, you are right that the name clashes with images.jl/algorithms. However, base has only the sorting algorithms implemented, and not all of them which are used in competitive programming are implemented.

However, the primary aim for developing this package is to help competitive programmers get up to speed with implementing algorithms in Julia (sort of a central repo with most used algorithm implementations), so that JuliaLang can get more love from the competitive domain 😄

So, as Julia.jl is a comprehensive source for Julia packages, this might be a good place to include it's link, so that it becomes more easily visible for new comers.

@svaksha
Copy link
Owner

svaksha commented Mar 7, 2016

On Mon, Mar 7, 2016 at 2:17 PM, Jalem Raj Rohit
notifications@github.com wrote:

You may want to consider using a more descriptive name

Yeah, but I chose the name to be easily searchable by newcomers, so maybe I'll stick with it. (However, I'll probably change it's name for a more clear and easy one later!). Thanks for the suggestion.

Algorithms are listed on this page :
https://github.com/svaksha/Julia.jl/blob/master/AI.md#algorithms
Let me know which category your package belongs to.

As regards search by newcomers, a package gains popularity by virtue
of its usability, the problem it solves, ease of installation and good
documentation, features, maintenance and upkeep, certainly not because
it has a catchy name. Just my zero paise worth.

I see that(but not sure) the repo in the second link isn't being actively developed. However, you are right that the name clashes with images.jl/algorithms.

However, the primary aim for developing this package is to help competitive programmers get up to speed with implementing algorithms in Julia (sort of a central repo with most used algorithm implementations), so that JuliaLang can get more love from the competitive domain

So, as Julia.jl is a comprehensive source for Julia packages, this might be a good place to include it's link, so that it becomes more easily visible by new comers.

There is some misunderstanding. Julia.jl is NOT a comprehensive
source for Julia packages, that position belongs to METADATA.jl, the
canonical source for packages. It seems that you are looking for more
users to download your package, so you should submit a PR to the
package repo as this repo is basically a list of lists, not a package
list.

HTH,
SVAKSHA ॥ http://about.me/svaksha

@Dawny33
Copy link
Author

Dawny33 commented Mar 7, 2016

Thanks for a clear explanation.

I think it might come under the [Sorting](https://github.com/svaksha/Julia.jl/blob/master/AI.md#sorting) category. However, it contains more than just sorting.

So, I'll submit a PR, once the package gets better with more implementations.

Thanks for being helpful!

@Dawny33 Dawny33 closed this as completed Mar 7, 2016
@tbreloff
Copy link
Contributor

tbreloff commented Mar 7, 2016

I agree with @svaksha here... Algorithms is a very broad term... you'll want to change that (see http://docs.julialang.org/en/release-0.4/manual/packages/#guidelines-for-naming-a-package). Likely if/when you decide to register your package on METADATA (see http://docs.julialang.org/en/release-0.4/manual/packages/#tagging-and-publishing-your-package) you'll probably get additional pushback on the name.

May I suggest something like: SearchSortAlgos.jl?

@Dawny33
Copy link
Author

Dawny33 commented Mar 7, 2016

@tbreloff Woah, nailed it with the name 😄

Yeah, I'll narrow down the scope and concentrate on search and sort algos. then!

@svaksha
Copy link
Owner

svaksha commented Mar 7, 2016

@Dawny33 See commit a297521

@Dawny33
Copy link
Author

Dawny33 commented Mar 7, 2016

@svaksha Thank you 😄

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

No branches or pull requests

3 participants