Skip to content

contributing.md

Latest commit

 

History

History
61 lines (43 loc) · 1.67 KB

contributing.md

File metadata and controls

61 lines (43 loc) · 1.67 KB

Contributing to OpenStudentStack

First off — thank you! Every resource you add helps a student somewhere find what they need faster. 🙏

How to Add a Resource

1. Fork & Clone

git clone https://github.com/YOUR_USERNAME/OpenStudentStack
cd OpenStudentStack

2. Open js/data.js

Find the correct category section (CODING, AI, ECE, etc.) and add your resource following this exact format:

{
  title: "Resource Name",
  desc:  "One or two sentences describing what it is and why it's useful for students.",
  cat:   "coding",   // coding | ai | ece | design | tools | internship | hackathon
  link:  "https://example.com",
  badge: "Free"      // short label: Free, India, Beginner, MIT, etc.
},

3. Checklist Before Submitting

  • Resource is free (no paywall for core content)
  • Link is working and correct
  • Description is one or two sentences, not a marketing pitch
  • Category is one of the 7 valid options
  • Badge is short (1-2 words max)

4. Submit a Pull Request

git checkout -b add/resource-name
git add js/data.js
git commit -m "add: Resource Name to [category]"
git push origin add/resource-name

Then open a Pull Request on GitHub with a short description of what you added and why it's useful.

Other Ways to Contribute

  • Fix a broken link — open an issue or a PR directly
  • Improve a description — keep it student-friendly and concise
  • Suggest a new category — open an issue to discuss
  • Report a paywalled resource — open an issue with the resource name

Code of Conduct

Be respectful. This is a student community. We're all here to help each other.