12 KiB

Raw Blame History

Hozzájárulás az Adattudomány Kezdőknek programhoz

Köszönjük, hogy érdeklődsz az Adattudomány Kezdőknek tananyaghoz való hozzájárulás iránt! Örömmel fogadjuk a közösség hozzájárulásait.

Tartalomjegyzék

Magatartási kódex

Ez a projekt a Microsoft Nyílt Forráskódú Magatartási Kódexét alkalmazza.
További információért lásd a Magatartási Kódex GYIK oldalt, vagy lépj kapcsolatba az opencode@microsoft.com címen bármilyen további kérdéssel vagy megjegyzéssel.

Hogyan járulhatok hozzá?

Hibák jelentése

Mielőtt hibajelentést készítenél, ellenőrizd a meglévő problémákat, hogy elkerüld a duplikációt. Hibajelentés készítésekor adj meg minél több részletet:

Használj egyértelmű és leíró címet
Írd le pontosan a probléma reprodukálásának lépéseit
Adj meg konkrét példákat (kódrészletek, képernyőképek)
Írd le az észlelt viselkedést és azt, amit vártál
Add meg a környezeted részleteit (operációs rendszer, Python verzió, böngésző)

Fejlesztési javaslatok

Fejlesztési javaslatokat szívesen fogadunk! Javaslat készítésekor:

Használj egyértelmű és leíró címet
Adj részletes leírást a javasolt fejlesztésről
Magyarázd el, miért lenne hasznos ez a fejlesztés
Sorolj fel hasonló funkciókat más projektekben, ha releváns

Dokumentációhoz való hozzájárulás

A dokumentáció fejlesztése mindig értékes:

Javítsd a helyesírási és nyelvtani hibákat
Tedd érthetőbbé a magyarázatokat
Egészítsd ki a hiányzó dokumentációt
Frissítsd az elavult információkat
Adj példákat vagy felhasználási eseteket

Kódhoz való hozzájárulás

Szívesen fogadjuk a kódhoz való hozzájárulásokat, például:

Új leckék vagy gyakorlatok
Hibajavítások
Meglévő notebookok fejlesztése
Új adathalmazok vagy példák
Kvíz alkalmazás fejlesztései

Első lépések

Előfeltételek

Hozzájárulás előtt győződj meg róla, hogy rendelkezel:

GitHub fiókkal
Git telepítve van a rendszereden
Python 3.7+ és Jupyter telepítve van
Node.js és npm (kvíz alkalmazás hozzájárulásokhoz)
Ismered a tananyag struktúráját

Lásd INSTALLATION.md a részletes telepítési útmutatóért.

Fork és Klónozás

Forkold a repót GitHubon

Klónozd a forkodat helyben:

git clone https://github.com/YOUR-USERNAME/Data-Science-For-Beginners.git
cd Data-Science-For-Beginners

Add hozzá az upstream távoli repót:

git remote add upstream https://github.com/microsoft/Data-Science-For-Beginners.git

Ág létrehozása

Hozz létre egy új ágat a munkádhoz:

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

Ágnevezési konvenciók:

feature/ - Új funkciók vagy leckék
fix/ - Hibajavítások
docs/ - Dokumentációs változtatások
refactor/ - Kód átszervezése

Hozzájárulási irányelvek

Leckék tartalmához

Leckék hozzáadásakor vagy meglévők módosításakor:

Kövesd a meglévő struktúrát:
- README.md a lecke tartalmával
- Jupyter notebook gyakorlatokkal
- Feladat (ha releváns)
- Link az előzetes és utólagos kvízekhez
Tartalmazza az alábbi elemeket:
- Egyértelmű tanulási célok
- Lépésről lépésre magyarázatok
- Kódpéldák kommentekkel
- Gyakorlatok gyakorlásra
- Linkek további forrásokhoz
Biztosítsd az akadálymentességet:
- Használj világos, egyszerű nyelvezetet
- Adj meg alternatív szöveget a képekhez
- Tartalmazz kódkommenteket
- Vedd figyelembe a különböző tanulási stílusokat

Jupyter Notebookokhoz

Töröld az összes kimenetet mielőtt elköteleznéd:

jupyter nbconvert --clear-output --inplace notebook.ipynb

Tartalmazz markdown cellákat magyarázatokkal

Használj következetes formázást:

# 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

Teszteld teljesen a notebookot beküldés előtt

Python kódhoz

Kövesd a PEP 8 stílusirányelveket:

# 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)

Kvíz alkalmazás hozzájárulásokhoz

A kvíz alkalmazás módosításakor:

Teszteld helyben:
```
cd quiz-app
npm install
npm run serve
```
Futtasd a lintert:
```
npm run lint
```
Építsd sikeresen:
```
npm run build
```
Kövesd a Vue.js stílusirányelveket és meglévő mintákat

Fordításokhoz

Fordítások hozzáadásakor vagy frissítésekor:

Kövesd a translations/ mappa struktúráját
Használd a nyelvkódot mappanévként (pl. fr francia esetén)
Tartsd meg az angol verzió fájlstruktúráját
Frissítsd a kvíz linkeket, hogy tartalmazzák a nyelvi paramétert: ?loc=fr
Teszteld az összes linket és formázást

Pull Request folyamat

Beküldés előtt

Frissítsd az ágad a legújabb változásokkal:
```
git fetch upstream
git rebase upstream/main
```
Teszteld a változtatásaidat:
- Futtasd az összes módosított notebookot
- Teszteld a kvíz alkalmazást, ha módosítottad
- Ellenőrizd az összes link működését
- Ellenőrizd a helyesírási és nyelvtani hibákat
Kötelezd el a változtatásaidat:
```
git add .
git commit -m "Brief description of changes"
```
Írj egyértelmű commit üzeneteket:
- Használj jelen időt ("Funkció hozzáadása" nem "Funkció hozzáadva")
- Használj felszólító módot ("Mozgasd a kurzort..." nem "Mozgatja a kurzort...")
- Korlátozd az első sort 72 karakterre
- Hivatkozz problémákra és pull requestekre, ha releváns

Pushold a forkodra:

git push origin feature/your-feature-name

Pull Request létrehozása

Lépj a repo oldalára
Kattints a "Pull requests" → "New pull request" gombra
Kattints a "compare across forks" gombra
Válaszd ki a forkodat és ágadat
Kattints a "Create pull request" gombra

PR cím formátuma

Használj egyértelmű, leíró címeket az alábbi formátumban:

[Component] Brief description

Példák:

[Lecke 7] Python notebook import hiba javítása
[Kvíz alkalmazás] Német fordítás hozzáadása
[Dokumentáció] README frissítése új előfeltételekkel
[Javítás] Adatútvonal javítása vizualizációs leckében

PR leírás

A PR leírásában szerepeljen:

Mi: Milyen változtatásokat végeztél?
Miért: Miért szükségesek ezek a változtatások?
Hogyan: Hogyan valósítottad meg a változtatásokat?
Tesztelés: Hogyan tesztelted a változtatásokat?
Képernyőképek: Mellékelj képernyőképeket vizuális változtatásokhoz
Kapcsolódó problémák: Hivatkozz kapcsolódó problémákra (pl. "Fixes #123")

Áttekintési folyamat

Automatikus ellenőrzések futnak a PR-eden
Karbantartók átnézik a hozzájárulásodat
Válaszolj a visszajelzésekre további commitokkal
Ha jóváhagyják, egy karbantartó összevonja a PR-t

Miután a PR-t összevonták

Töröld az ágad:

git branch -d feature/your-feature-name
git push origin --delete feature/your-feature-name

Frissítsd a forkodat:

git checkout main
git pull upstream main
git push origin main

Stílusirányelvek

Markdown

Használj következetes címsorszinteket
Hagyj üres sorokat a szakaszok között
Használj kódblokkokat nyelvi specifikációval:
```
```python
import pandas as pd
```
```
Adj alternatív szöveget a képekhez: ![Alt szöveg](../../translated_images/hu/image.4ee84a82b5e4c9e6651b13fd27dcf615e427ec584929f2cef7167aa99151a77a.png)
Tartsd a sorhosszokat ésszerű határok között (kb. 80-100 karakter)

Python

Kövesd a PEP 8 stílusirányelveket
Használj értelmes változóneveket
Adj docstringeket a függvényekhez

Használj típusjelzéseket, ahol releváns:

def process_data(df: pd.DataFrame) -> pd.DataFrame:
    """Process the input dataframe."""
    return df

JavaScript/Vue.js

Kövesd a Vue.js 2 stílusirányelveket
Használj a megadott ESLint konfigurációt
Írj moduláris, újrafelhasználható komponenseket
Adj kommenteket a bonyolult logikához

Fájlok szervezése

Tartsd az összefüggő fájlokat együtt
Használj leíró fájlneveket
Kövesd a meglévő könyvtárstruktúrát
Ne kötelezz el felesleges fájlokat (.DS_Store, .pyc, node_modules stb.)

Hozzájárulói licencszerződés

Ez a projekt szívesen fogad hozzájárulásokat és javaslatokat. A legtöbb hozzájárulás megköveteli, hogy
elfogadj egy Hozzájárulói Licencszerződést (CLA), amely kijelenti, hogy jogod van, és ténylegesen megadod nekünk a jogokat a hozzájárulásod felhasználására. Részletekért látogass el a
https://cla.microsoft.com oldalra.

Amikor pull requestet nyújtasz be, egy CLA-bot automatikusan meghatározza, hogy szükséges-e
CLA-t biztosítanod, és megfelelően megjelöli a PR-t (pl. címke, megjegyzés). Egyszerűen kövesd a
bot által megadott utasításokat. Ezt csak egyszer kell megtenned az összes CLA-t használó repó esetében.

Kérdések?

Nézd meg a Discord csatornánkat #data-science-for-beginners
Csatlakozz a Discord közösségünkhöz
Nézd át a meglévő problémákat és pull requesteket

Köszönjük!

A hozzájárulásaid jobbá teszik ezt a tananyagot mindenki számára. Köszönjük, hogy időt szánsz a hozzájárulásra!

Felelősség kizárása:
Ez a dokumentum az Co-op Translator AI fordítási szolgáltatás segítségével került lefordításra. Bár törekszünk a pontosságra, kérjük, vegye figyelembe, hogy az automatikus fordítások hibákat vagy pontatlanságokat tartalmazhatnak. Az eredeti dokumentum az eredeti nyelvén tekintendő hiteles forrásnak. Kritikus információk esetén javasolt professzionális emberi fordítást igénybe venni. Nem vállalunk felelősséget semmilyen félreértésért vagy téves értelmezésért, amely a fordítás használatából eredhet.

12 KiB Raw Blame History