diff --git a/README.md b/README.md index 4ab3c605..ecdf5dfe 100644 --- a/README.md +++ b/README.md @@ -1 +1,60 @@ # GoodFirstIssue +GoodFirstIssue is a platform that helps developers-especially beginners-discover open-spource repositories with beginner-friendly issues such as **good first issue** and **help wanted**. + +The goal is to make contribution to open source easier by surfacing high quality repositories and relevant issues in one place. + +--- + +## 🚀 Features + +- List GitHub repositories with counts of issues having specific labels +- Sort repositories based on: + - Number of beginner-friendly issues + - Stars + - Recent activity (last pull request) + - Notifications when new **good first issues** appear + - Bookmark repositories and add personal notes + - Filter repositories from large organizations (e.g. Facebook, Google, Apple) + +--- + + +## Project Idea + +Many beginners struggle to find the right open-source project to contribute to. + +GoodFirstIssue aims to solve this by: + +- Highlighting active repostories +- Prioritizing beginner-friendly issues +- Providing signals like starts and recend activity +- Reducing noise from inactive or isolated projects + + +--- + +## Planned Enhancements + +- Email or notification system for new beginner issues +- Github newsletter highlighting trending repositories +- Community-written articles and guides +- Better caching strategies to reduce API requests + + +## Contributing + +Contributions are welcome! + +If you're new to open source, this project is a great place to start. +You can help by: +- Improving documentation +- Suggesting features +- Fixing bugs +- Enhancing UI/UX + + +--- + +## 📄 Notes + +Initial project ideas and brainstorming notes can be found in `spec.md`. \ No newline at end of file