Skip to content

Latest commit

 

History

History
114 lines (73 loc) · 3.94 KB

README.md

File metadata and controls

114 lines (73 loc) · 3.94 KB
Raw

FOSS CDN (Can't Decide Name) v0.1.0-alpha

🚀 Welcome to the Beginner-Friendly Bug Hunt!

If you want to improve your coding skills, you're in the right place. This is an open-source project designed for beginners to learn by doing. We've purposely added bugs to some code examples, and we're inviting you to fix them!

Project Overview

🔍 What's Inside?

Inside this repository, you'll find code files with intentional bugs. Your mission, should you choose to accept it, is to:

  • 🐞 Identify and fix these bugs.
  • 📝 Explain the issues and your solutions.
  • 📚 Write clear commit messages to document your changes.

🤓 While knowing a programming language is helpful, it's not required. What's essential is understanding Git and GitHub.

Prerequisites

  1. 🧑 💻 Basic understanding of Git and GitHub.
  2. 🤓 Familiarity with at least one programming language (basic knowledge is enough).
  3. 🌐 Internet connection for downloading resources.

Contributing

We welcome contributions from the community to help identify and fix bugs in the code. Here's how you can get involved:

For Experienced Git Users

  1. 🍴 Fork the repository on GitHub.

  2. 💻 Clone your forked repository to your computer.

    git clone https://github.com/your-username/fossinit.git

  3. 🌿 Create a new branch for your changes.

    git checkout -b bug-fix-branch-rollno # or any other name you like, but relevant

  4. 🛠️ Make your code changes and commit them with clear messages.

    git commit -m "fix: describe what you fixed"

  5. 🚀 Push your changes to your forked repository.

    git push origin bug-fix-branch

  6. 🔄 Create a Pull Request (PR) on GitHub, including a clear description of the bug and your fix.

For Contributors Not Familiar with Git CLI

  1. 🍴 Click the "Fork" button at the top right of this repository to create your own copy. (If you have already forked, ensure that you sync the repository by going to https://github.com/your-username/fossinit.git and then click on sync option present at the top)
  2. 🌐 Make your code changes directly in your forked repository using the GitHub web interface.
  3. 📝 Describe your changes and commit them.
  4. 🚀 Create a Pull Request (PR) on the original repository by clicking the "New Pull Request" button.
  5. 📄 Provide a clear description of the bug and your fix in the PR description.
  6. 📤 Submit the PR for review.

Adding New Buggy Codes

If you want to add more buggy code examples to this repository, follow these steps:

  1. 🍴 Fork the repository on GitHub.

  2. 💻 Clone your forked repository to your computer.

    git clone https://github.com/your-username/fossinit.git

  3. 🌿 Create a new branch for your new buggy code.

    git checkout -b new-bug-branch

  4. ➕ Add your new buggy code files to the repository.

  5. 🛠️ Commit your changes with descriptive messages.

    git commit -m "add: description of the new buggy code"

  6. 🚀 Push your changes to your forked repository.

    git push origin new-bug-branch

  7. 🔄 Create a Pull Request (PR) on GitHub, providing details about the new buggy code and its purpose.

This way, you can contribute by both fixing existing bugs and adding new ones for others to tackle.

Bug Reporting

If you come across a bug in the code that you can't fix or if you'd like to report a new bug, please open a new issue on GitHub. Describe the problem, including any error messages you received.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details. 📜

✨ Contributors

Grid of profile icons of the contributors