13 KiB
תרומה למדעי הנתונים למתחילים
תודה על התעניינותך בתרומה לתוכנית הלימודים של מדעי הנתונים למתחילים! אנו מקבלים בברכה תרומות מהקהילה.
תוכן עניינים
- קוד התנהגות
- איך אפשר לתרום?
- התחלת עבודה
- הנחיות לתרומה
- תהליך בקשת משיכה
- הנחיות סגנון
- הסכם רישיון תורם
קוד התנהגות
הפרויקט הזה אימץ את קוד ההתנהגות של קוד פתוח של מיקרוסופט.
למידע נוסף, ראה את שאלות נפוצות על קוד ההתנהגות
או צור קשר עם opencode@microsoft.com לכל שאלה או הערה נוספת.
איך אפשר לתרום?
דיווח על באגים
לפני יצירת דיווחי באגים, אנא בדוק את הבעיות הקיימות כדי להימנע מכפילויות. כאשר אתה יוצר דיווח על באג, כלול כמה שיותר פרטים:
- השתמש בכותרת ברורה ותיאורית
- תאר את הצעדים המדויקים לשחזור הבעיה
- ספק דוגמאות ספציפיות (קטעי קוד, צילומי מסך)
- תאר את ההתנהגות שצפית בה ומה ציפית שיקרה
- כלול פרטי סביבת העבודה שלך (מערכת הפעלה, גרסת Python, דפדפן)
הצעת שיפורים
הצעות לשיפורים תמיד מתקבלות בברכה! כאשר אתה מציע שיפורים:
- השתמש בכותרת ברורה ותיאורית
- ספק תיאור מפורט של השיפור המוצע
- הסבר מדוע השיפור הזה יהיה שימושי
- ציין תכונות דומות בפרויקטים אחרים, אם רלוונטי
תרומה לתיעוד
שיפורים בתיעוד תמיד מוערכים:
- תיקון שגיאות כתיב ודקדוק
- שיפור בהירות ההסברים
- הוספת תיעוד חסר
- עדכון מידע מיושן
- הוספת דוגמאות או מקרי שימוש
תרומה לקוד
אנו מקבלים בברכה תרומות קוד, כולל:
- שיעורים או תרגילים חדשים
- תיקוני באגים
- שיפורים במחברות קיימות
- סטים חדשים של נתונים או דוגמאות
- שיפורים באפליקציית החידונים
התחלת עבודה
דרישות מוקדמות
לפני שתתרום, ודא שיש לך:
- חשבון GitHub
- Git מותקן במערכת שלך
- Python 3.7+ ו-Jupyter מותקנים
- Node.js ו-npm (לתרומות לאפליקציית החידונים)
- היכרות עם מבנה התוכנית
ראה INSTALLATION.md להוראות התקנה מפורטות.
יצירת Fork ושכפול
-
צור Fork של המאגר ב-GitHub
-
שכפל את ה-Fork שלך באופן מקומי:
git clone https://github.com/YOUR-USERNAME/Data-Science-For-Beginners.git cd Data-Science-For-Beginners -
הוסף מקור upstream:
git remote add upstream https://github.com/microsoft/Data-Science-For-Beginners.git
יצירת ענף
צור ענף חדש לעבודה שלך:
git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix
שמות ענפים מומלצים:
feature/- תכונות או שיעורים חדשיםfix/- תיקוני באגיםdocs/- שינויים בתיעודrefactor/- שינוי מבנה קוד
הנחיות לתרומה
עבור תוכן שיעורים
כאשר אתה תורם שיעורים או משנה שיעורים קיימים:
-
עקוב אחר המבנה הקיים:
- README.md עם תוכן השיעור
- מחברת Jupyter עם תרגילים
- משימה (אם רלוונטי)
- קישור לחידונים לפני ואחרי
-
כלול את האלמנטים הבאים:
- מטרות למידה ברורות
- הסברים שלב אחר שלב
- דוגמאות קוד עם הערות
- תרגילים לתרגול
- קישורים למשאבים נוספים
-
ודא נגישות:
- השתמש בשפה ברורה ופשוטה
- ספק טקסט חלופי לתמונות
- כלול הערות בקוד
- התחשב בסגנונות למידה שונים
עבור מחברות Jupyter
-
נקה את כל הפלטים לפני התחייבות:
jupyter nbconvert --clear-output --inplace notebook.ipynb -
כלול תאי Markdown עם הסברים
-
השתמש בעיצוב עקבי:
# Import libraries at the top import pandas as pd import numpy as np import matplotlib.pyplot as plt # Use meaningful variable names # Add comments for complex operations # Follow PEP 8 style guidelines -
בדוק את המחברת שלך לחלוטין לפני הגשה
עבור קוד Python
עקוב אחר הנחיות הסגנון של PEP 8:
# Good practices
import pandas as pd
def calculate_mean(data):
"""Calculate the mean of a dataset.
Args:
data (list): List of numerical values
Returns:
float: Mean of the dataset
"""
return sum(data) / len(data)
עבור תרומות לאפליקציית החידונים
כאשר אתה משנה את אפליקציית החידונים:
-
בדוק באופן מקומי:
cd quiz-app npm install npm run serve -
הרץ לינטור:
npm run lint -
בנה בהצלחה:
npm run build -
עקוב אחר מדריך הסגנון של Vue.js ודפוסים קיימים
עבור תרגומים
כאשר אתה מוסיף או מעדכן תרגומים:
- עקוב אחר המבנה בתיקיית
translations/ - השתמש בקוד השפה כשם התיקייה (לדוגמה,
frעבור צרפתית) - שמור על אותו מבנה קבצים כמו הגרסה באנגלית
- עדכן קישורי חידונים לכלול פרמטר שפה:
?loc=fr - בדוק את כל הקישורים והעיצוב
תהליך בקשת משיכה
לפני הגשה
-
עדכן את הענף שלך עם השינויים האחרונים:
git fetch upstream git rebase upstream/main -
בדוק את השינויים שלך:
- הרץ את כל המחברות ששונו
- בדוק את אפליקציית החידונים אם שונתה
- ודא שכל הקישורים עובדים
- בדוק שגיאות כתיב ודקדוק
-
התחייב לשינויים שלך:
git add . git commit -m "Brief description of changes"כתוב הודעות התחייבות ברורות:
- השתמש בזמן הווה ("הוסף תכונה" ולא "הוספתי תכונה")
- השתמש במצב ציווי ("העבר את הסמן ל..." ולא "מעביר את הסמן ל...")
- הגבל את השורה הראשונה ל-72 תווים
- התייחס לבעיות ובקשות משיכה כשמתאים
-
דחף ל-Fork שלך:
git push origin feature/your-feature-name
יצירת בקשת משיכה
- עבור אל המאגר
- לחץ על "Pull requests" → "New pull request"
- לחץ על "compare across forks"
- בחר את ה-Fork והענף שלך
- לחץ על "Create pull request"
פורמט כותרת PR
השתמש בכותרות ברורות ותיאוריות לפי הפורמט הבא:
[Component] Brief description
דוגמאות:
[Lesson 7] Fix Python notebook import error[Quiz App] Add German translation[Docs] Update README with new prerequisites[Fix] Correct data path in visualization lesson
תיאור PR
כלול בתיאור ה-PR שלך:
- מה: אילו שינויים ביצעת?
- למה: מדוע השינויים האלה נחוצים?
- איך: איך יישמת את השינויים?
- בדיקות: איך בדקת את השינויים?
- צילומי מסך: כלול צילומי מסך לשינויים חזותיים
- בעיות קשורות: קישור לבעיות קשורות (לדוגמה, "Fixes #123")
תהליך סקירה
- בדיקות אוטומטיות ירוצו על ה-PR שלך
- מתחזקים יסקורו את התרומה שלך
- טפל במשוב על ידי ביצוע התחייבויות נוספות
- לאחר אישור, מתחזק ימזג את ה-PR שלך
לאחר שה-PR שלך מוזג
-
מחק את הענף שלך:
git branch -d feature/your-feature-name git push origin --delete feature/your-feature-name -
עדכן את ה-Fork שלך:
git checkout main git pull upstream main git push origin main
הנחיות סגנון
Markdown
-
השתמש ברמות כותרות עקביות
-
כלול שורות ריקות בין חלקים
-
השתמש בבלוקי קוד עם מפרטי שפה:
```python import pandas as pd ``` -
הוסף טקסט חלופי לתמונות:
 -
שמור על אורך שורות סביר (בסביבות 80-100 תווים)
Python
- עקוב אחר מדריך הסגנון של PEP 8
- השתמש בשמות משתנים משמעותיים
- הוסף docstrings לפונקציות
- כלול רמזי סוג כשמתאים:
def process_data(df: pd.DataFrame) -> pd.DataFrame: """Process the input dataframe.""" return df
JavaScript/Vue.js
- עקוב אחר מדריך הסגנון של Vue.js 2
- השתמש בתצורת ESLint שסופקה
- כתוב רכיבים מודולריים וניתנים לשימוש חוזר
- הוסף הערות ללוגיקה מורכבת
ארגון קבצים
- שמור קבצים קשורים יחד
- השתמש בשמות קבצים תיאוריים
- עקוב אחר מבנה התיקיות הקיים
- אל תתחייב קבצים מיותרים (.DS_Store, .pyc, node_modules וכו')
הסכם רישיון תורם
הפרויקט הזה מקבל בברכה תרומות והצעות. רוב התרומות דורשות ממך להסכים להסכם רישיון תורם (CLA) שמצהיר שיש לך את הזכות, ואתה אכן מעניק לנו את הזכויות להשתמש בתרומתך. לפרטים, בקר בכתובת
https://cla.microsoft.com.
כאשר אתה מגיש בקשת משיכה, CLA-bot יקבע באופן אוטומטי אם עליך לספק CLA ויעטר את ה-PR בהתאם (לדוגמה, תווית, הערה). פשוט עקוב אחר ההוראות שסופקו על ידי הבוט. תצטרך לעשות זאת רק פעם אחת בכל המאגרים שמשתמשים ב-CLA שלנו.
שאלות?
- בדוק את ערוץ הדיסקורד שלנו #data-science-for-beginners
- הצטרף לקהילת דיסקורד שלנו
- עיין ב-בעיות קיימות וב-בקשות משיכה
תודה!
התרומות שלך הופכות את תוכנית הלימודים הזו לטובה יותר עבור כולם. תודה על הזמן שהקדשת לתרום!
כתב ויתור:
מסמך זה תורגם באמצעות שירות תרגום מבוסס בינה מלאכותית Co-op Translator. למרות שאנו שואפים לדיוק, יש לקחת בחשבון שתרגומים אוטומטיים עשויים להכיל שגיאות או אי דיוקים. המסמך המקורי בשפתו המקורית צריך להיחשב כמקור הסמכותי. עבור מידע קריטי, מומלץ להשתמש בתרגום מקצועי על ידי אדם. איננו נושאים באחריות לאי הבנות או לפרשנויות שגויות הנובעות משימוש בתרגום זה.