Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (53 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

66 lines (53 loc) · 1.62 KB

Contributing to SkillRahi

Thank you for considering contributing! 🎉
SkillRahi is open-source because we want the community to build + improve practical learning resources for students.

We welcome beginners. If this is your first ever open-source contribution — you are at the right place.

Ways you can contribute

  • Add new lessons (Markdown content)
  • Add new project ideas (hands-on practice builds)
  • Improve UI/UX
  • Improve docs / grammar / spelling
  • Fix bugs
  • Add new features
  • Refactor code / cleanup
  • Review pull requests

Getting Started (local setup)

  1. Fork this repo
  2. Clone your fork locally
git clone https://github.com/<your-username>/skillrahi.git
cd skillrahi
# Create a branch
git checkout -b feature/my-feature
npm install
# Setup .env (see .env.example)
npm run dev

Commit message rules

Please use simple meaningful commit messages Examples

  • New Feature
  • feat: add new lesson for HTML basics
  • Bug Fix
  • fix: dashboard progress query
  • improve readme formating
  • docs: improve readme formatting
  • code cleanup
  • refactor: move components into ui folder

Pull Request Guidelines

Before submitting a PR:

  • make sure it builds (npm run dev works)
  • format code using prettier
  • describe clearly “what changed” and “why”
  • keep PRs focused (ONE purpose per PR)

then push your branch

git push origin feature/my-feature

and open a Pull Request.

Thank you 💙 This project grows faster when more students contribute. Your contribution matters — small or big.

We accept PRs from beginners — even small UI fixes, typo fixes, or code cleanup.