איך לתרום מודול 8 דרופל לקהילה?
לפני שתחליט לתרום מודול לקהילת דרופל, ועוד לפני שתבצע את המודול, ודא שאין עדיין מודול שמישהו אחר תרם שעושה את אותו הדבר.
דרופל הוא כלי לבניית אתרים. באופן ספציפי יותר, מדובר במערכת ניהול תוכן עם קוד פתוח (מפותח קהילה). זה אומר שהוא מסתמך על חברי הקהילה (כמוך) כדי לשפר את זה. למרבה המזל, תרומה של מודולים מותאמים אישית היא משהו שכל אחד יכול לעשות.
חלק 1 מתוך 3: הכנת המודול
- 1אל תמציאו את הגלגל מחדש (למעט תרגול). לפני שתחליט לתרום מודול לקהילת דרופל, ועוד לפני שתבצע את המודול, ודא שאין עדיין מודול שמישהו אחר תרם שעושה את אותו הדבר. אם יש, כנראה שעדיף לתמוך במודול ההוא שעושה משלך.
- 2צור את המודול (אם עדיין לא עשית זאת). אם עדיין לא יצרת את המודול שלך, שקול להשתמש ב- Drupal Console (כלי פיתוח מועיל מאוד) כדי לבנות אותו עבורך. לאחר התקנתו, פשוט הפעל את הפקודה
$ drupal generate:moduleו-$ drupal module:install {name} - 3ארז אותו למתן. לאחר שהמודול שלך מוכן לפרסום, הוסף קובץ README.md (סימון) המסביר את כל מה שמישהו המשתמש במודול שלך יצטרך לדעת. לדוגמה:
- מבוא. (מה זה עושה, למי זה מיועד)
- תכונות
- דרישות (מודולים אחרים וכו ')
- שאלות נפוצות
- התקנה
- שימוש (כיצד מפתח / בעל אתר / מבקר באתר משתמש בו)
- פתרון תקלות
- הערות טכניות (בנייה, כלים וכו ')
- תחזוקה (אנשים פרטיים, עסקים)
- 4התחייבי לגיט. עקוב אחר התהליך הסטנדרטי של ביצוע קודך. אך לפני שתעשה זאת, ודא שיש לך קובץ .gitignore. ואז להשתמש
init,add, וcommitפקודות.
אם עדיין לא יצרת את המודול שלך, שקול להשתמש ב- Drupal Console (כלי פיתוח מועיל מאוד) כדי לבנות אותו עבורך.
חלק 2 מתוך 3: מסירתו ל- drupal.org
- 1היכנס ל- drupal.org. אם אין לך חשבון, צור חשבון. ואז התחבר.
- 2צור פרויקט חדש. עבור אל → "החשבון" שלך → דף "הפרויקטים" שלך → "הוסף פרויקט חדש" → "פרויקט המודול".
- 3מלא את טופס הפרויקט החדש. עדיף שתספק מידע מועיל לאנשים המחליטים אם עליהם להוריד ולהשתמש במודול שלך; אתה יכול לקחת את זה מן README שלך קובץ אם יצרת אותו מוקדם יותר (אך להשאיר את הדברים הטכניים).
- 4דחף אותו אל drupal.org. פשוט עקוב אחר ההוראות שסופקו.
- 5צור מהדורה. עבור אל "ערוך" → "מהדורות" → "הוסף מהדורה חדשה". אם לחצת על הקוד נכון, תראה אפשרות ליצור מהדורה חדשה.
- 6מלא את טופס השחרור החדש. ראה מוסכמות שחרור שחרור וראה יצירת מהדורת פרויקט ב- Drupal.org.
- 7הבן שחרורים ואבטחה. Dev → Alpha → Beta → RC → יציב. כדי לקבל כיסוי אבטחה (התג הירוק) עבור המודול שלך, עליך להגיש בקשה למעמד נבדק בתור הכיסוי של יעוץ האבטחה. חברי צוות האבטחה או מתנדבים אחרים יבדקו את בקשתכם - ועשויים להציע שינויים בפרויקט שלכם. לאחר פתרונות המשוב, תוענק לך התפקיד הנבדק ותוכל לבחור בפרויקט זה ובכל פרויקטים עתידיים שתיצור כדי לקבל כיסוי ייעוץ ביטחוני.
- רק שחרורים יציבים זוכים לכיסוי ייעוץ ביטחוני, כך שגם לאחר שתבחר בפרויקט שלך לא תקבל את מגן הכיסוי הייעוץ אלא בשחרורים יציבים.
כדי לקבל כיסוי אבטחה (התג הירוק) עבור המודול שלך, עליך להגיש בקשה למעמד נבדק בתור הכיסוי של יעוץ האבטחה.
חלק 3 מתוך 3: שיפור זה
- 1בצע את תקני הקידוד. ל- Drupal יש סטנדרטים לאופן שבו יש לעצב את הקוד. למשל, כרטיסיות עדיפות על פני רווחים. ראה תקני קידוד ב- Drupal.org. ראה גם מדריך סגנון סימון דרופל ואפילו תקני אבטחה של דרופל. שקול להשתמש במודול קודן, אשר יכול לעזור לך לוודא שהקוד שלך מעוצב כהלכה.
- 2כתוב מבחנים. ביצוע בדיקות יבטיח שהקוד שלך עובד בתדירות גבוהה יותר במקרי שימוש רבים יותר, ויגרום לתסכול פחות כאשר אתה צריך לתקן באגים. שקול להשתמש במבחני יחידות, בדיקות פונקציונליות וכו 'דרופל 8 משתמש בעיקר ב- PHPUnit לבדיקת PHP. שקול להשתמש בבהט לבדיקות פונקציונליות.
- 3כתוב תיעוד (אם המודול שלך מורכב). ראה phpDocumentor. למעשה, קוד אינטואיטיבי הוא אפילו טוב יותר מאשר הערות, וזה בהחלט טוב יותר מאשר אין תגובות.
- 4תקן בעיות באמצעות תיקונים. בדוק באופן קבוע את תור הבעיות של המודול שלך לגבי דברים שצריך לתקן. כדי להחיל תיקון, אתה יכול להשתמש בפקודה git, או בפקודה "תיקון" (ברוב הגרסאות של לינוקס).
מאמרים בנושאים דומים
