search

Rahul-Vijay / C_plus_plus_Algos

Collection of C++ Algorithms for a quick reference. Fork it and start hacking :)
0 stars 32 forks source link

Refactoring the structure of the repository #41

Open alexander-ponomaroff opened 5 years ago

alexander-ponomaroff commented 5 years ago

I noticed that the naming of the files varies in format and the way the repo is structured may be confusing.

I would like to suggest refactoring the repo to have the same naming convention for the files (For example: have all file names in this format, KnapsackProblem.cpp, and encourage people to maintain this format, so that contributors don't commit files with different naming format (knapsack_problem.cpp, knapsackProblem.cpp, etc.). We can then create a "How to Contribute" file, in which we can specify the rules, which contributors should follow when committing additional files.

In addition, the files are stored in and out of folders and can be reorganized to follow a folder structure, which can also be specified in the README.md file.

I would like to work on this over the next week and communicate with you ( @Rahul-Vijay ) on how the final product will look like. In this issue we can discuss the uniform naming convention for this repo and the folder structure. Please let me know if you are interested and let me know if I can proceed developing my idea further.

Rahul-Vijay commented 5 years ago

Sure. This was actually on my mind. I completely agree with you @alexander-ponomaroff and lets discuss on how we should proceed. I would suggest making separate folders as sub topics such as Recursion algorithms, Sorting Algorithms etc. Under those directories, we could add in the required algorithms and provide description. As you say, a contributor's guidelines file would also be really helpful. I'm closing issue #3 and we could re-open it once we have some guidelines.

alexander-ponomaroff commented 5 years ago

@Rahul-Vijay I am very busy this week until Friday. We can discuss everything in detail on Friday if that is ok with you? Do you agree that we should name the files in this manner, "MergeSort.cpp", instead of "merge_sort.cpp" "mergeSort.cpp"... ?

alexander-ponomaroff commented 5 years ago

@Rahul-Vijay I've refactored the whole repository into a folder structure, renamed the files, and added a file for newcomers to follow if they'd like to contribute. Please review the pull request and let me know what you think.

The new structure can be viewed here: https://github.com/alexander-ponomaroff/C_plus_plus_Algos/tree/issue-41

The next step can be expanding CONTRIBUTING.md to include more instructions and list of possible contributions. And the next step can also be to rewrite the README.md to follow the new structure and add naming and descriptions for each algorithm and problem in the README.md

Rahul-Vijay commented 5 years ago

The refactoring was a good job @alexander-ponomaroff ! The next step as you say should be updating README.md file and also some additional guidelines for contributors.

ishsum commented 5 years ago

sir could you tell me that why did you close my merge request?

Rahul-Vijay commented 5 years ago

@ishsum Can you reference the PR number ? If it was closed, it was because of either of the following reasons-