Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 2.85 KB

README.md

File metadata and controls

70 lines (47 loc) · 2.85 KB

Data Structure & Algorithms (DSA)

A repository to store different types of Data-Structure & Algorithms for educational and research purposes.

This repository is divided into 2 parts:

Each has its own hierarchy system. The hierarchy is strict, and must be followed.

Hierarchy & Rules

  • Directory names should be in PascalCase.
  • There could be links to and from the Algorithms or DataStructure dir to link related things.

/Algorithms

The /Algorithms directory is organized to accommodate various algorithm implementations, information, explanations, and supplementary details.

Within /Algorithms, the following subdirectories represent different categories of algorithms:

  • /Sort: Contains algorithms for sorting data.
  • /Search: Includes algorithms for searching within a list.
  • /Utils: Houses algorithms that serve multiple purposes.

Each category directory (/Sort, /Search, /Utils) further includes directories for specific algorithms.

Algorithm Directory Template

AlgorithmName/
    │
    ├── README.md          // Containing Pseudocode 
    │
    └── AlgorithmName.xxx  // (optional) Code implementation (.xxx is extention like java, cpp)

/DataStructure

The /DataStructure directory is structured to house various data structure implementations, information, explanations, and supporting materials.

Within /DataStructure, different categories represent various types of data structures:

  • /Linear: Contains implementations of linear data structures.
  • /NonLinear: Encompasses implementations of non-linear data structures.
  • /HashBased: Stores implementations of hash-based data structures.
  • /Specialized: Includes specialized data structures.

Each category directory (/Linear, /NonLinear, /HashBased, /Specialized) further contains subdirectories for subcategories of data structures or specific data structures.

DataStructure Directory Template

DataStructureName/
    │
    ├── README.md             // Containing description & diagram or the structure
    │
    └── DataStrucureName.xxx  // (optional) Code implementation (.xxx is extention like java, cpp)

Contributions

We welcome contributions! Here's how you can contribute to our project:

  • Report Issues: Help by reporting bugs or suggesting enhancements. Check existing issues before creating a new one.

  • Pull Requests (PRs): Submit focused PRs for review. Remember to follow the code style.

  • Code Reviews: Review PRs from others. Offer constructive feedback to improve code quality.

For more detailed guidelines, please refer to our Contribution Guide.

Your contributions are highly appreciated! 🎉