Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 1.93 KB

File metadata and controls

61 lines (41 loc) · 1.93 KB
# 🙌 Contributing to OptiGrade Welcome! 🎓 OptiGrade is an open-source academic AI assistant built with heart by a solo developer — now calling for collaborators to grow it into a global solution for student success. Whether you're fixing a bug, improving the user interface, optimizing model performance, or suggesting new features — your contribution matters! --- ## ✏️ Ways You Can Contribute - 🧠 Improve ML model accuracy and recommendations - 🎨 Help polish UI/UX on Streamlit or Figma prototypes - 📖 Enhance documentation and onboarding flow - 🧪 Write unit tests or improve performance - 🕵️ Suggest features, report bugs, or optimize code - 📦 Review and expand academic resource libraries --- ## 🚀 Getting Started 1. **Fork the repository** Click “Fork” at the top of this repo to create your copy. 2. **Clone your fork locally** ```bash git clone https://github.com//OptiGrade-ML-model.git 3. **Create a new branch** ```bash git checkout -b your-feature-name 4. **Commit your changes** Be descriptive in your commit messages and include references to related issues if applicable. 5. **Push and submit a pull request** Once you're ready: ```bash git push origin your-feature-name Then visit GitHub to create your pull request. --- ## ✅ Contributor Recognition OptiGrade uses all-contributors to highlight community contributors with emoji tags in the README. **Add yourself via CLI:** ```bash npx all-contributors add npx all-contributors generate **Or comment in a PR:** ```bash @all-contributors please add for code, doc, design --- ## 🛡️ Code of Conduct