TheAlgorithms/C-Plus-Plus

[FIX] Pre-existing algorithms do not fit the contribution guidelines

Open

#2,456 opened on Apr 30, 2023

View on GitHub
 (15 comments) (7 reactions) (0 assignees)C++ (7,801 forks)batch import
dont-closeenhancementhelp wanted

Repository metrics

Stars
 (34,244 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Detailed description

Some of the older algorithms existing in this repository do not fit the contribution guidelines.

A short list of examples:

Context

Educating new developers on coding standards is a major priority; As the industry today relies heavily on documentation; If you were to ask any API developer/user on what the most important part of their development and use it will always be:

  • Code quality
  • documentation

having a fast and performant algorithm is good but whats the point if you cant understand how it works or even why it works.

I think it is in the best interest of us to document our algorithms.

As i consider all algorithms must be:

  • beautiful
  • understandable
  • educational

Possible implementation

No response

Additional information

Others in the past have made major changes like this to this repository and i think its time for us to do the same. to keep the torch moving.

An homage to @kvedala for their part in trying to standardize this repository #805

Contributor guide