איך לתרום לפרוייקט הזה ולתרגל תרומה לקוד פתוח?

מטרת הפרוייקט היא תרומה של קובץ md שיוצג באתגר בחלק של poeple. דוגמה לתרומה מוצלחת אפשר לראות פה- דוגמא לתרומה

1. יש לפתוח אישיו

כאשר אתם פותחים issue חדש יש לכם אפשרות לפתוח אישיו של הוספת md, בחרו get started והכניסו אישיו. כאשר תשימו את הלייבל 'md' על האישיו - באופן אוטומטי תשובצו לקבל אחריות עליו.

מדריך באנגלית של גיטהאב לפתיחת issue

2. יש לעשות fork לפרוייקט כדי שתוכלו לערוך אותו

מדריך באנגלית של גיטהאב לפתיחת fork

3. יש לעשות clone למחשב האישי שלכם.

מדריך באנגלית של גיטהאב לפתיחת clone מקומי

4. פתחו בראנץ' חדש ובצעו בו את השינויים הרצויים.

מדריך באנגלית של גיטהאב לפתיחת בראנץ'

5. לאחר ביצוע commit יש לבצע push לריפו האישי שלכם.

הפקודות הנדרשות ל commit ול push הן:

git commit -m "your commit message" 
git push --set-upstream origin <branch-name>

שימו לב ששם branch זה משהו שיצרתם בסעיף 4

6. פתחו pull-request. נא לציין איזה issue אתם מעוניינים לסגור.

מדריך באנגלית של גיטהאב לפתיחת pull-request

ומה שנשאר זה שהמתחזק של הפרוייקט יאשר את ה pull-request שלכם! ואז תוכלו לראות את הקובץ שהוספתם בכתובת הזו באינטרנט: https://melodious-muffin-2be5a1.netlify.app/docs/intro/ כשתפתחו בתפריט את people :)

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ npm install

Local Development

$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.