11 KiB

Raw Blame History

Osallistuminen Data Science for Beginners -projektiin

Kiitos kiinnostuksestasi osallistua Data Science for Beginners -opetussuunnitelmaan! Otamme mielellämme vastaan yhteisön panoksia.

Sisällysluettelo

Toimintaohjeet

Tämä projekti on omaksunut Microsoft Open Source Code of Conduct. Lisätietoja saat Code of Conduct FAQ -sivulta tai ottamalla yhteyttä opencode@microsoft.com, jos sinulla on kysymyksiä tai kommentteja.

Kuinka voin osallistua?

Virheiden raportointi

Ennen kuin luot virheraportin, tarkista olemassa olevat ongelmat välttääksesi päällekkäisyyksiä. Kun luot virheraportin, sisällytä mahdollisimman paljon yksityiskohtia:

Käytä selkeää ja kuvaavaa otsikkoa
Kuvaile tarkat vaiheet ongelman toistamiseksi
Anna konkreettisia esimerkkejä (koodinpätkiä, kuvakaappauksia)
Kuvaile havaittua käyttäytymistä ja odotuksiasi
Sisällytä ympäristötiedot (käyttöjärjestelmä, Python-versio, selain)

Parannusehdotusten tekeminen

Parannusehdotukset ovat tervetulleita! Kun ehdotat parannuksia:

Käytä selkeää ja kuvaavaa otsikkoa
Anna yksityiskohtainen kuvaus ehdotetusta parannuksesta
Selitä, miksi tämä parannus olisi hyödyllinen
Listaa vastaavia ominaisuuksia muissa projekteissa, jos sovellettavissa

Dokumentaation parantaminen

Dokumentaation parannukset ovat aina arvostettuja:

Korjaa kirjoitus- ja kielioppivirheet
Paranna selitysten selkeyttä
Lisää puuttuvaa dokumentaatiota
Päivitä vanhentunutta tietoa
Lisää esimerkkejä tai käyttötapauksia

Koodin kontribuointi

Otamme mielellämme vastaan koodipanoksia, kuten:

Uusia oppitunteja tai harjoituksia
Virheiden korjauksia
Parannuksia olemassa oleviin muistikirjoihin
Uusia tietoaineistoja tai esimerkkejä
Visailusovelluksen parannuksia

Aloittaminen

Esivaatimukset

Ennen osallistumista varmista, että sinulla on:

GitHub-tili
Git asennettuna järjestelmääsi
Python 3.7+ ja Jupyter asennettuna
Node.js ja npm (visailusovelluksen kontribuutioita varten)
Tuntemus opetussuunnitelman rakenteesta

Katso INSTALLATION.md yksityiskohtaisia asennusohjeita varten.

Haaroita ja kloonaa

Haaroita arkisto GitHubissa

Kloonaa haarasi paikallisesti:

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

Lisää upstream-remote:

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

Luo haara

Luo uusi haara työllesi:

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

Haaran nimeämiskäytännöt:

feature/ - Uudet ominaisuudet tai oppitunnit
fix/ - Virheiden korjaukset
docs/ - Dokumentaatiomuutokset
refactor/ - Koodin uudelleenjärjestely

Osallistumisohjeet

Oppituntisisällön osalta

Kun osallistut oppitunteihin tai muokkaat olemassa olevia:

Noudata olemassa olevaa rakennetta:
- README.md oppituntisisällön kanssa
- Jupyter-muistikirja harjoituksilla
- Tehtävä (jos sovellettavissa)
- Linkki ennen ja jälkeen visailuihin
Sisällytä nämä elementit:
- Selkeät oppimistavoitteet
- Vaiheittaiset selitykset
- Koodiesimerkit kommentteineen
- Harjoituksia harjoittelua varten
- Linkkejä lisäresursseihin
Varmista saavutettavuus:
- Käytä selkeää, yksinkertaista kieltä
- Lisää alt-tekstiä kuviin
- Sisällytä koodikommentteja
- Huomioi erilaiset oppimistyylit

Jupyter-muistikirjojen osalta

Tyhjennä kaikki tulosteet ennen sitoutumista:

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

Sisällytä markdown-solut selityksillä

Käytä johdonmukaista muotoilua:

# 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

Testaa muistikirjasi kokonaan ennen lähettämistä

Python-koodin osalta

Noudata PEP 8 -tyyliohjeita:

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

Visailusovelluksen kontribuutioiden osalta

Kun muokkaat visailusovellusta:

Testaa paikallisesti:
```
cd quiz-app
npm install
npm run serve
```
Aja linter:
```
npm run lint
```
Rakenna onnistuneesti:
```
npm run build
```
Noudata Vue.js-tyyliohjeita ja olemassa olevia malleja

Käännösten osalta

Kun lisäät tai päivität käännöksiä:

Noudata rakennetta translations/-kansiossa
Käytä kielikoodia kansion nimenä (esim. fi suomelle)
Säilytä sama tiedostorakenne kuin englanninkielisessä versiossa
Päivitä visailulinkit sisältämään kieliparametri: ?loc=fi
Testaa kaikki linkit ja muotoilu

Pull Request -prosessi

Ennen lähettämistä

Päivitä haarasi uusimmilla muutoksilla:

git fetch upstream
git rebase upstream/main

Testaa muutoksesi:
- Aja kaikki muokatut muistikirjat
- Testaa visailusovellus, jos sitä on muokattu
- Varmista, että kaikki linkit toimivat
- Tarkista oikeinkirjoitus- ja kielioppivirheet
Sitouta muutoksesi:
```
git add .
git commit -m "Brief description of changes"
```
Kirjoita selkeät commit-viestit:
- Käytä preesensmuotoa ("Lisää ominaisuus" ei "Lisätty ominaisuus")
- Käytä imperatiivimuotoa ("Siirrä kursori..." ei "Siirtää kursoria...")
- Rajoita ensimmäinen rivi 72 merkkiin
- Viittaa ongelmiin ja pull requesteihin, kun se on olennaista

Puske haarasi:

git push origin feature/your-feature-name

Pull Requestin luominen

Siirry arkistoon
Klikkaa "Pull requests" → "New pull request"
Klikkaa "compare across forks"
Valitse haarasi ja haara
Klikkaa "Create pull request"

PR-otsikon muoto

Käytä selkeitä, kuvaavia otsikoita seuraavan mallin mukaisesti:

[Component] Brief description

Esimerkkejä:

[Lesson 7] Korjaa Python-muistikirjan tuontivirhe
[Quiz App] Lisää saksankielinen käännös
[Docs] Päivitä README uusilla esivaatimuksilla
[Fix] Korjaa datan polku visualisointitehtävässä

PR-kuvaus

Sisällytä PR-kuvaukseesi:

Mitä: Mitä muutoksia teit?
Miksi: Miksi nämä muutokset ovat tarpeellisia?
Miten: Kuinka toteutit muutokset?
Testaus: Kuinka testasit muutokset?
Kuvakaappaukset: Sisällytä kuvakaappauksia visuaalisista muutoksista
Liittyvät ongelmat: Linkitä liittyviin ongelmiin (esim. "Fixes #123")

Tarkistusprosessi

Automaattiset tarkistukset suoritetaan PR:ssäsi
Ylläpitäjät tarkistavat kontribuutiosi
Vastaa palautteeseen tekemällä lisäsitoutumisia
Kun PR hyväksytään, ylläpitäjä yhdistää sen

PR:n yhdistämisen jälkeen

Poista haarasi:

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

Päivitä haarasi:

git checkout main
git pull upstream main
git push origin main

Tyyliohjeet

Markdown

Käytä johdonmukaisia otsikkotasoja
Sisällytä tyhjiä rivejä osioiden väliin
Käytä koodilohkoja kielimäärityksillä:
```
```python
import pandas as pd
```
```
Lisää alt-tekstiä kuviin: ![Alt-teksti](../../translated_images/fi/kuva.a2a8c9070e65ff3c7c6a6dc945dcd333c7807f900cd4709e93198d0022bd0d3d.png)
Pidä rivien pituudet kohtuullisina (noin 80-100 merkkiä)

Python

Noudata PEP 8 -tyyliohjeita
Käytä merkityksellisiä muuttujanimiä
Lisää docstringit funktioihin

Sisällytä tyyppivihjeet tarvittaessa:

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

JavaScript/Vue.js

Noudata Vue.js 2 -tyyliohjeita
Käytä annettua ESLint-konfiguraatiota
Kirjoita modulaarisia, uudelleenkäytettäviä komponentteja
Lisää kommentteja monimutkaiselle logiikalle

Tiedostojen organisointi

Pidä liittyvät tiedostot yhdessä
Käytä kuvaavia tiedostonimiä
Noudata olemassa olevaa hakemistorakennetta
Älä sitouta tarpeettomia tiedostoja (.DS_Store, .pyc, node_modules, jne.)

Osallistujan lisenssisopimus

Tämä projekti toivottaa tervetulleeksi kontribuutiot ja ehdotukset. Useimmat kontribuutiot vaativat, että hyväksyt Contributor License Agreement (CLA) -sopimuksen, jossa vakuutat, että sinulla on oikeus antaa meille oikeudet käyttää kontribuutiotasi. Lisätietoja saat osoitteesta https://cla.microsoft.com.

Kun lähetät pull requestin, CLA-bot määrittää automaattisesti, tarvitsetko CLA:n ja merkitsee PR:n asianmukaisesti (esim. etiketti, kommentti). Seuraa yksinkertaisesti botin antamia ohjeita. Sinun tarvitsee tehdä tämä vain kerran kaikissa arkistoissa, jotka käyttävät CLA:ta.

Kysymyksiä?

Tarkista Discord-kanavamme #data-science-for-beginners
Liity Discord-yhteisöömme
Tarkista olemassa olevat ongelmat ja pull requestit

Kiitos!

Panoksesi tekee tästä opetussuunnitelmasta paremman kaikille. Kiitos, että käytät aikaa osallistumiseen!

Vastuuvapauslauseke:
Tämä asiakirja on käännetty käyttämällä tekoälypohjaista käännöspalvelua Co-op Translator. Vaikka pyrimme tarkkuuteen, huomioithan, että automaattiset käännökset voivat sisältää virheitä tai epätarkkuuksia. Alkuperäistä asiakirjaa sen alkuperäisellä kielellä tulisi pitää ensisijaisena lähteenä. Kriittisen tiedon osalta suositellaan ammattimaista ihmiskäännöstä. Emme ole vastuussa väärinkäsityksistä tai virhetulkinnoista, jotka johtuvat tämän käännöksen käytöstä.

11 KiB Raw Blame History