Skip to content

GET_STARTED.md

Latest commit

 

History

History
116 lines (76 loc) · 4.05 KB

GET_STARTED.md

File metadata and controls

116 lines (76 loc) · 4.05 KB

Algo Stars

Welcome to Algo Stars, a GitHub organization dedicated to showcasing the prowess of Data Structures and Algorithms (DSA) and programming skills of our community members. This repository structure is designed to provide a structured and engaging way for contributors to improve their coding skills.

Table of Contents

Getting Started

To get started with Algo Stars, make sure you have a GitHub account. If you don't have one, you can create one here.

Repository Structure

Programming Language Repositories

We have separate repositories for different programming languages, each containing three subdirectories: basic, intermediate, and advanced. Within each of these subdirectories, you'll find weekly problem statements in the form of .txt files.

Example:

  • Repository: Algo-Stars/Python
    • Subdirectories:
      • basic/
      • intermediate/
      • advanced/
    • Problem Statement: basic/week1/problem_statement.txt

Project Repository

Apart from language-specific repositories, there's a project repository containing challenges and projects that span multiple programming languages.

How to Contribute

Contributing to Algo Stars is straightforward. Follow the steps below:

Forking the Repository

  1. Navigate to the repository you want to contribute to (e.g., Algo-Stars/Python).
  2. Click on the "Fork" button in the top right corner of the page.
    • This creates a copy of the repository in your GitHub account.

Cloning the Forked Repository

  1. On your forked repository, click on the "Code" button, and copy the URL.

  2. Open your terminal and run the following command, replacing <your-username> with your GitHub username:

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

Making Changes

  1. Navigate to the problem statement directory (e.g., basic/week1/).
  2. Solve the problem using the online program editor linked in the README.
  3. Save your solution in a file named <your-username>.<programming-language-extension>.

Pushing Changes

  1. In the terminal, navigate to your cloned repository:

    cd Python

  2. Add your changes and commit:

    git add .
git commit -m "Solved basic week 1 problem"

  3. Push the changes to your GitHub repository:

    git push origin main

Creating a Pull Request

  1. Visit your forked repository on GitHub.
  2. Click on the "Pull Requests" tab.
  3. Click the "New Pull Request" button.
  4. Set the base repository to Algo-Stars/Python and the base branch to main.
  5. Set the head repository to <your-username>/Python and the compare branch to main.
  6. Click the "Create Pull Request" button.
  7. Add a title and description, then click "Create Pull Request" again.

Congratulations! You've just contributed to Algo Stars!!!

Additional Learning Resources

For a more detailed understanding of Git and GitHub operations, you may find the following video tutorials helpful:

  1. Git & GitHub Crash Course For Beginners by Apna College

  2. Git & GitHub Crash Course For Beginners by Kunal Kushwaha

  3. Git & GitHub Crash Course For Beginners by Traversy Media

Code of Conduct

Please adhere to our Code of Conduct to ensure a positive and inclusive environment for everyone.

Happy coding! 🚀