OpenGenus / cosmos

World's largest Contributor driven code dataset | Used in Quark Search Engine, @OpenGenus IQ, OpenGenus Visual Project
http://internship.opengenus.org
GNU General Public License v3.0
13.58k stars 3.69k forks source link

Respect repo guidelines #2944

Open arthurlacoste opened 6 years ago

arthurlacoste commented 6 years ago

I noticed some folders use "-" or "_" to replace a space. It can be good to have a convention about that and make all folders in the same way, and some folder have a "algorithms" word on it, others, not.

Same with algo files, in this example, you can saw :

We can use a naming convention like underscore and camelCase, and keep it.

This is a(n):

Details:

Vitorvgc commented 6 years ago

Actually, there is already a convention. As stated in the contribution guidelines:

Naming convention: folders and filenames should be in lowercase and each word separated by _. Names should be descriptive to certain extend. 👍

Unfortunately there are still some inconsistencies. But a script has been created to help in this issue in OpenGenus/cosmos-format.

arthurlacoste commented 6 years ago

This sound good to me !

But instead of using script to try perform this thing, we can commit with the good files name from the start. 👍

arnavb commented 6 years ago

@arthurlacoste I am currently working on a PR, that fixes every file in this way in the mathematical-algorithms section (which should be mathematical_algorithms 😆 ). The reason I am doing this manually is sometimes even the folder name is not named properly at times.