תרומה ל-OSS-IL

תודה שאתם מעוניינים לתרום לקטלוג הקוד הפתוח הישראלי!

איך להוסיף פרויקט

שלב 1: הכנת מידע על הפרויקט

ודאו שיש לכם את המידע הבא:

שם הפרויקט
תיאור קצר
קישור ל-GitHub
קישור לאתר (אופציונלי)
קטגוריות (לדוגמה: web, devtools, AI, mobile)
Issues לתרומה

שלב 2: הוספת Issues באמצעות הסקריפט

השתמשו בסקריפט fetch-issue כדי לייצר את המידע על כל Issue:

pnpm fetch-issue https://github.com/owner/repo/issues/123

הסקריפט יחזיר קטע YAML מוכן להעתקה:

- title: "שם ה-Issue"
  url: https://github.com/owner/repo/issues/123
  difficulty: beginner  # מזוהה אוטומטית מהלייבלים
  labels:
    - bug
    - good first issue

שלב 3: עריכת קובץ הפרויקטים

פתחו את data/projects.yaml והוסיפו את הפרויקט:

projects:
  # פרויקטים קיימים...

  - name: "שם הפרויקט שלכם"
    description: "תיאור קצר של הפרויקט"
    repoUrl: "https://github.com/owner/repo"
    websiteUrl: "https://example.com"  # אופציונלי
    categories:
      - web
      - devtools
    issues:
      - title: "שם ה-Issue"
        url: https://github.com/owner/repo/issues/123
        difficulty: beginner
        labels:
          - bug
          - good first issue

רמות קושי

beginner - מתאים למתחילים, בדרך כלל מתויג כ-"good first issue"
intermediate - דורש היכרות עם הפרויקט
advanced - מורכב, דורש הבנה עמוקה של הקוד

איך להוסיף קהילה

פתחו את data/communities.yaml והוסיפו:

communities:
  # קהילות קיימות...

  - title: "שם הקהילה"
    description: "תיאור קצר"
    link: "https://link-to-community.com"

שליחת Pull Request

עשו Fork לפרויקט
צרו branch חדש: git checkout -b add-my-project
בצעו את השינויים
ודאו שהבילד עובר: pnpm build
Commit: git commit -m "feat: add [project-name] to catalog"
Push: git push origin add-my-project
פתחו Pull Request

הנחיות

ודאו שהפרויקט הוא קוד פתוח
הוסיפו רק Issues שעדיין פתוחים
השתמשו בעברית לתיאורים
עקבו אחרי המבנה הקיים בקבצי ה-YAML

שאלות?

פתחו Issue בפרויקט או צרו קשר דרך הקהילות המופיעות באתר.