תודה על הנכונות להשקיע זמן ולתרום לפרויקט! קראו את ה-Code of Conduct כדי שנוכל לשמור על הקהילה שלנו נעימה ומכבדת.
אם מעולם לא תרמתם לקוד פתוח, צפו בסרטון ההדרכה הקצר שמדגים תרומה ראשונית לקוד פתוח בפרויקט התרגול של הקהילה.
אם יש לכם כח, הנה עוד מידע רלוונטי בנושא:
- How to Contribute to Open Source
- Understanding the GitHub flow
- GitHub Help Documentation
- GitHub Flavored Markdown
כל התוכן נמצא בקבצי md שמכילים טקסט פשוט. כדי להוסיף ולערוך תכנים באתר, קודם חשוב להבין איך הוא בנוי.
תיקיית pages
מכילה את עמודי הקטגוריה הראשיים, אלו שמופיעים בתפריט העליון (עמוד הבית, מתחילים, משתתפים וכו').
תיקיית content
מכילה את התכנים שמקושרים לכל עמוד קטגוריה, בתוך התיקייה המתאימה. אלו התכנים שמוצגים בתפריט הצד.
אתרו את המיקום שאליו תרצו להוסיף תוכן. האם אתם רוצים לבצע שינויים בתוכן קיים בעמוד הקטגוריה עצמו? או אולי להוסיף עמוד חדש תחת עמוד קטגוריה מסוים?
אם אתם לא בטוחים - צרו איתנו קשר ע"י תיוג באישיו / כתבו בדיסקורד.
משתמשי מאק יכולים להנות מהתקנה מהירה ע"י הרצת הפקודות הבאות:
brew install cocmd/tap/cocmd
cocmd run maakaf.onboarding --from https://github.com/Maakaf/maakaf-tempצרו בגיטהאב שלכם Fork לפרויקט
צרו Clone מקומי ל-Fork על ידי:
git clone https://github.com/[your-github-user]/maakaf-temp.git
cd maakaf-tempהתקנת הספריות דורשת nodejs מגרסא 14.22+
Please use pnpm as package manger instead of npm
# install dependencies
pnpm i
# add new packages, if needed
pnpm add
# remove unused packages, if needed
pnpm remove
# run a script from package.json
pnpm <script-name>
# For example:
pnpm dev
pnpm buildצרו Branch עבור הפיצ'ר שתרצו לעבוד עליו
git checkout -b my-new-featureזה הזמן לקודד!
עשו Commit לשינויים שביצעתם על ידי:
git commit -m 'Add some feature'דחפו את השינויים ל-Fork שלכם
git push -u origin my-new-featureכשסיימתם לעבוד על השינויים שלכם, פתחו PR בפרויקט.
כל התרומות לפרויקט עוברות קוד ריוויו על ידי מנהלי הפרויקט לפני שהן ממוזגות אליו.
אם זיהיתם בעיה בקוד שאתם מאמינים שצריך לתקן, או שיש לכם רעיון לפיצ'ר חדש, בדקו את רשימת האישיוז הקיימים פה Issues אם אין אישיו פתוח שמתייחס לבעיה שזיהיתם, פתחו אחד חדש. תנו לאישיו כותרת ותיאור ברורים, הסבירו איך לשחזר את הבעיה, צרפו צילומי מסך, וספקו כל מידע שיעזור לאחרים להבין את כוונתכם.
עברו על האישיוז הקיימים Issues ומצאו אחד שמעניין אתכם. וודאו שאין מישהו שמטפל באישיו הזה כבר, והגיבו עליו בבקשה לקבל אותו. לאחר שהוגדרתם כ-assignee לאישיו, תוכלו להתחיל לעבוד עליו. עקבו אחר השלבים שתוארו למעלה.
הידד! 🎉🎉 ברגע שה-PR שלכם מוזג אל הפרויקט, התרומה שלכם תופיע לייב באתר ואפשר יהיה לראות אותה בקוד של הפרויקט
הפרויקט הזה עובד לפי Google's Open Source Community Guidelines.
המדריך הזה הוא בהשראת GitHub docs contributing guide.
We currently provide support for both Hebrew and English languages. To organize your content, please place your markdown files within the content directory under the relevant subdirectory.
To filter the content for the desired language, make use of the lang property in the frontmatter of each markdown file. You can trust that it offers type safety, so there's no need to worry!
Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.