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

Refactoring the structure of the repository #41

Open
alexander-ponomaroff opened this issue Oct 15, 2018 · 6 comments
Open

Refactoring the structure of the repository #41

alexander-ponomaroff opened this issue Oct 15, 2018 · 6 comments

Comments

@alexander-ponomaroff
Copy link
Contributor

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
Copy link
Owner

Rahul-Vijay commented Oct 16, 2018

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
Copy link
Contributor Author

@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 added a commit to alexander-ponomaroff/C_plus_plus_Algos that referenced this issue Oct 19, 2018
@alexander-ponomaroff
Copy link
Contributor Author

alexander-ponomaroff commented Oct 19, 2018

@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 added a commit that referenced this issue Oct 20, 2018
Fix issue #41 – Project Fully Refactored, Files Renamed, CONTRIBUTING.md added
@Rahul-Vijay
Copy link
Owner

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
Copy link
Contributor

ishsum commented Oct 22, 2018

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

@Rahul-Vijay
Copy link
Owner

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

  • Unnecessary commits

  • Duplicate commit

  • Doesn't solve the issue

  • Files too large to commit

  • Invalid merge request

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