Skip to content

Latest commit

 

History

History
171 lines (134 loc) · 5.1 KB

CONTRIBUTING.md

File metadata and controls

171 lines (134 loc) · 5.1 KB
Raw

Contributing to Algo

Thank you for your interest in contributing to Algo! We welcome contributions from everyone, whether you're a beginner or an experienced developer. Contributions can include adding new algorithms, improving documentation, fixing bugs, or enhancing the user experience. This guide will help you get started.

Resources for Guidance

Here are some resources that may be helpful as you contribute to Algo:

How to Contribute

1. Fork the Repository

Start by forking the repository to your GitHub account. This creates a copy of the repository under your account.

2. Clone Your Fork

Clone the repository to your local machine using:

$ git clone https://github.com/<your-username>/algo.git

3. 📂 Change the working directory:

   cd algo

4. 🔗 Add a reference to the original repository.

   git remote add upstream https://github.com/ajay-dhangar/algo.git

5. 🔍 Check the remotes for this repository.

   git remote -v

6. ⬇️ Always take a pull from the upstream repository to your main branch to keep it up-to-date with the main project (updated repository).

   git pull upstream main

7. 🌿 Create a new branch.

   git checkout -b <your-branch-name>

4. Make Your Changes

Make your changes, which could include:

  • Adding new algorithms
  • Improving existing documentation
  • Creating new documentation pages
  • Fixing bugs

5. Writing Documentation for Algo

If your contribution involves documentation, here’s how to write effective content using Docusaurus:

a. Markdown & MDX

  • Documentation should be written in Markdown (.md) or MDX (.mdx), which supports JSX syntax.
  • MDX allows you to use React components inside Markdown files. This helps add interactive elements or custom components.

b. Content Structure

image

Each documentation file should start with a front-matter section for Docusaurus to recognize the page:

---
id: <unique-id>
title: <Page Title>
sidebar_label: <Sidebar Label>
sidebar_position: <Position in Sidebar>
description: <Short Description>
tags: [<tag1>, <tag2>]
---
  • id: A unique identifier for the page.
  • title: The page title.
  • sidebar_label: The label is displayed in the sidebar.
  • sidebar_position: Order of the page in the sidebar.
  • description: A short description of the page content.
  • tags: Tags for categorizing content.

c. Using Headings

  • Use # for the main title, ## for subsections, and ### for sub-subsections.
  • Ensure headings follow a logical order.

d. Adding Code Blocks

  • Use fenced code blocks for code snippets:

    ```python
  def binary_search(arr, target):
      low, high = 0, len(arr) - 1
      while low <= high:
          mid = (low + high) // 2
          if arr[mid] == target:
              return mid
          elif arr[mid] < target:
              low = mid + 1
          else:
              high = mid - 1
      return -1
  ```

e. Adding Math Formulas

  • Use KaTeX for rendering math expressions:

      $$ E = mc^2 $$

  • Refer to the KaTeX documentation for supported features.

f. Diagrams and Visuals with Mermaid

  • Create diagrams using Mermaid syntax:

      ```mermaid
  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;
  ```

g. Using React Components

  • Import React components for interactivity:

     import MyComponent from '@site/src/components/MyComponent';
 
 <MyComponent />

6. Commit Your Changes

Commit your changes with a descriptive message:

$ git commit -m "Added algorithm for [algorithm-name]"

7. Push to Your Fork

Push your changes to the forked repository:

$ git push origin <branch-name>

8. Create a Pull Request

Go to the original repository and create a Pull Request (PR). Provide a clear description of what was added or changed and why. Reference any related issues in your PR description.

Code Style and Quality

  • Keep your code clean and readable.
  • Follow standard coding conventions for the language used.
  • Add comments for complex code to help others understand.

Contribution Guidelines

  • Make sure your contributions align with the project’s goals and guidelines.
  • Keep PRs focused on a single issue; avoid making unrelated changes.
  • Respect the repository structure and follow best practices.

Thank you for contributing! Let's build Algo and create an amazing learning platform for mastering Data Structures and Algorithms. ✨