vxhl / DSA-Docs

πŸ“ƒ A repository for polishing the documentation culture while writing code on DSA

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DSA&Docs πŸ“

A repository for polishing the documentation culture while writing code.

PRs Welcome maintained yes contributions welcome

Overview

This is a practice project where you can push in detailed implementations of your code, meaning Documentation in the form of comments. You are required to make comments on every major line in your code and make an effort to explain the logic as concisely as possible.

Each contributed file must contain the 1️⃣: problem statement, 2️⃣most efficient (time and space) solution and 3️⃣Clean commenting on the logic

Steps to your contiribution:

Step 1 - Fork the repository (your own copy)

Step 2 - Create new branch (isolates your code)

Step 3 - Commit and push (add changes to your copy of repoitory)

Step 4 - Create Pull Request (contribute to the original repository)

Step 5 - We will review it and push in after a review on your approach and comments more specifically.

About

πŸ“ƒ A repository for polishing the documentation culture while writing code on DSA


Languages

Language:Java 98.9%Language:Python 1.1%Language:C++ 0.0%