tech-writing-contribution

Howdy, y'all! This is a fun first-timer repo for everyone who's learning to write technical documentation and/or looking forward to contributing to fixing broken documentation.

🧹 Markdown Cleanup Challenge – Fork & Fix It!

This repository contains a deliberately broken documentation file: BROKEN_GUIDE.md. Your challenge is to:

🔍 Identify and Fix Issues Such As:

• Spelling and grammar errors
• Incorrect command usage (git clon, git commt, etc.)
• Improper bullet or step numbering
• Inconsistent formatting (uppercase, lowercase, spacing)
• Steps out of order
• Incorrect git branch creation and push commands
• Ambiguous or unclear language
• Incomplete guide
• Missing images for a better explanation

---

✅ How to Contribute:

1. Identify an issue within the BROKEN_GUIDE.md and create an issue on this repository.
2. Fork this repo once the issue is validated and assigned.
3. Clone it to your local machine.
4. Create a new branch (e.g., @yourUsername/fix/broken-doc).
5. Fix the issues in BROKEN_GUIDE.md.
6. Push your changes and open a pull request with a clear commit message

---

🧠 Tips/resources:

• Follow the Google Developer Style Guide
• Refer to Git/GitHub command guide (https://medium.com/@pranitb10/contributing-to-open-source-a-beginners-guide-to-making-pull-requests-and-mastering-7e2d58613dd6)
• Keep instructions beginner-friendly
• Use correct code block formatting
• Number your steps logically and consistently
• Test the commands before recommending them

---

📬 Want to go further?

Please add suggestions or enhancements to the fixed document (e.g., screenshots, git config tips, PR template basics).

Happy hacking and may the Open-Source be with you! 💻✍️