Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

61 lines (44 loc) · 2.37 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.

Resources for Guidance

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

How to Contribute

1. Fork the Repository ( Video 1 )

Start by forking the repository to your GitHub account.

2. Clone Your Fork

Clone the repository to your local machine using:

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

3. Create a New Branch (Video 2 )

Create a branch for your contribution:

$ git checkout -b <branch-name>

4. Make Your Changes ( Video 3, Video 4 )

Add new algorithms, improve documentation, or fix any issues. Be sure to:

  • Document your code with clear comments
  • Ensure that your solution is correct and efficient

5. Commit Your Changes ( Video 5 )

Commit your changes with a descriptive commit message:

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

6. Push to Your Fork

Push your changes to your forked repository:

$ git push origin <branch-name>

7. Create a Pull Request

Go to the original repository and create a Pull Request (PR). Make sure to describe what you’ve changed and why.

Contribution Guidelines

  • Keep your code clean and well-documented.
  • Stick to best practices for the programming language you are contributing in.
  • Respect the folder structure and organization of the repository.

Thank you for your contributions! Together, we can build something amazing. ✨