Skip to content

fix: correct broken URLs, typos, and add missing project files#11

Open
maniapulai wants to merge 1 commit into4aibsc:mainfrom
maniapulai:fix/readme-improvements-and-missing-files
Open

fix: correct broken URLs, typos, and add missing project files#11
maniapulai wants to merge 1 commit into4aibsc:mainfrom
maniapulai:fix/readme-improvements-and-missing-files

Conversation

@maniapulai
Copy link

Summary

This PR fixes several issues in the repository and adds standard open-source project files.

Changes

🐛 Bug Fixes (README.md)

Issue Fix
Broken image URLs Changed soonchain/4aibsc/ (lines 2, 19)
Typo Changed "Framwork" → "Framework"
Broken tag link Removed invalid edit URL, replaced with bold text
Invalid JSON Changed {1, 3, 4}[1, 3, 4] (proper array syntax)
Poor alt text Improved image accessibility

✨ New Files Added

File Description
LICENSE MIT License - standard open source license
.gitignore Common ignore patterns for development
CONTRIBUTING.md Detailed contribution guidelines with examples

Why These Changes?

  1. Broken URLs - Images were not loading because they referenced the wrong repository owner
  2. Professional standards - Open source projects should have LICENSE, .gitignore, and CONTRIBUTING files
  3. Code quality - The JSON example had invalid syntax that could confuse contributors

Testing

  • Verified image URLs now point to correct repository
  • Confirmed JSON syntax is valid
  • All new files follow standard conventions

Thank you for reviewing! 🚀

## Changes:

### README.md Fixes:
- Fix broken image URLs (soonchain → 4aibsc)
- Fix typo: 'Framwork' → 'Framework'
- Fix broken tag link (removed invalid edit URL)
- Fix invalid JSON syntax in example: {1, 3, 4} → [1, 3, 4]
- Improve image alt text for accessibility

### New Files Added:
- LICENSE (MIT) - Standard open source license
- .gitignore - Common ignore patterns for development
- CONTRIBUTING.md - Detailed contribution guidelines

These changes improve documentation accuracy and project professionalism.
@maniapulai
Copy link
Author

..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant