Cosmos: Respect repo guidelines

Created on 3 Nov 2017  路  3Comments  路  Source: OpenGenus/cosmos

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 :

  • affine_cipher
  • affine
  • Affine

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

This is a(n):

  • [ ] New algorithm
  • [ ] Update to an existing algorithm
  • [ ] Error
  • [x] Proposal to the Repository

Details:

Most helpful comment

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.

All 3 comments

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.

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. 馃憤

@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.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

rhendz picture rhendz  路  4Comments

InfiniteCoder picture InfiniteCoder  路  3Comments

athangkanos picture athangkanos  路  4Comments

ivanrein picture ivanrein  路  4Comments

skywalker212 picture skywalker212  路  3Comments