Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 3.7 KB

README.md

File metadata and controls

95 lines (67 loc) · 3.7 KB
Raw

CLI-For-You

Welcome to CLI-For-You, a repository packed with useful CLI tools, including an engaging RPG game! Dive into this collection of tools designed to entertain, educate, and assist.

📚 Table of Contents

🔍 How It Works

The repository is organized into separate folders, each containing a distinct tool that serves a specific purpose. Here are the current tools:

  • QR-Encoder-Decoder: A CLI tool to encode data into QR codes and decode QR codes back into data.
  • TexToImage: Converts LaTeX-style text input into image files, perfect for creating elegant mathematical visuals or formatted text.
  • My-RPG: A command-line-based RPG game for the geeky gamer in you! Start with a basic storyline and expand it step by step through code.

This is just the beginning! As tools are completed, new ones will be added to keep your interest alive and your skills sharp.

⚡ Tech Stack

Here’s a breakdown of the technologies used for each tool:

  • QR-Encoder-Decoder: Any scripting language
  • TexToImage: Node.js
  • My-RPG: Node.js

🛠️ How to Setup and Contribute

General Instructions

  1. Fork and Clone the repository: 
    git clone <forked-repo-link>
  2. Navigate to the project directory: 
    cd CLI-For-You

Tool-Specific Contribution Instructions

For more details, you can visit the tool specific readme files in each folder.

  • QR-Encoder-Decoder: Issues for this tool are open to everyone. Create a new branch named after your GitHub username and create a folder with name as your github username. Place your code in the corresponding folder. Commit, push, and create a PR.

  • TexToImage and My-RPG: These issues are either first-come, first-serve (FCFS) or competitive. Commit your changes directly to the main branch of your forked repository, then create a PR.

  • Future Tools: Instructions will be provided when new issues are published.

Refer to the PR_Template.md for detailed guidelines on submitting a pull request.

💻 Communication

Have questions or ideas? Let’s collaborate! Reach out via our Discord channel. We’re here to help and excited to hear your thoughts.

👆 Claim an Issue

  1. Comment on the issue you wish to work on.
  2. If there’s no activity for two days after claiming, the issue may be reassigned.
  3. Stuck? Don’t hesitate to ask for assistance on Discord.

Don’t forget to make your entry in the CONTRIBUTORS.md file before submitting your PR.

📋 Contribution Guidelines

To maintain quality and streamline the review process, please follow these guidelines:

  • People Before Code: Be respectful and considerate towards community members.
  • Meaningful Commits: Use descriptive commit messages and reference related issue numbers.
  • Show Your Work: Attach relevant screenshots or short videos to simplify reviews.
  • Avoid Duplicate PRs: If required, link the follow-up PR in the comments of the original and close the obsolete one.
  • PR Response Time: PRs with no updates for three days may be closed.
  • Politeness Matters: Maintain a positive and constructive tone in discussions.

🤝 Mentors

  • Shivansh Gupta

  • Shaurya Singh