Skip to content

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

Description

@realstealthninja

Detailed description

Times change

so does the development of algorithms and documentation

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    dont-closeThis issue/pull request shouldn't be closedenhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    In progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions