25 KiB
தொடக்கநிலை தரவியல் அறிவியல் பாடத்திட்டத்திற்கு பங்களிப்பு
தரவியல் அறிவியல் தொடக்கநிலை பாடத்திட்டத்திற்கு பங்களிக்க ஆர்வம் காட்டியதற்கு நன்றி! சமூகத்திலிருந்து பங்களிப்புகளை வரவேற்கிறோம்.
உள்ளடக்க அட்டவணை
- நடத்தை விதிமுறைகள்
- நான் எப்படி பங்களிக்க முடியும்?
- தொடங்குவது எப்படி
- பங்களிப்பு வழிகாட்டுதல்கள்
- புல் கோரிக்கை செயல்முறை
- உருவக விதிமுறைகள்
- பங்களிப்பாளர் உரிமம் ஒப்பந்தம்
நடத்தை விதிமுறைகள்
இந்த திட்டம் Microsoft Open Source Code of Conduct ஐ ஏற்றுக்கொண்டுள்ளது.
மேலும் தகவலுக்கு Code of Conduct FAQ ஐ பார்க்கவும் அல்லது opencode@microsoft.com ஐ தொடர்பு கொள்ளவும்.
நான் எப்படி பங்களிக்க முடியும்?
பிழைகளை அறிவித்தல்
பிழை அறிக்கைகளை உருவாக்குவதற்கு முன், ஏற்கனவே உள்ள பிரச்சினைகளைச் சரிபார்த்து, நகல்களைத் தவிர்க்கவும். பிழை அறிக்கையை உருவாக்கும்போது, அதிக விவரங்களைச் சேர்க்கவும்:
- தெளிவான மற்றும் விளக்கமான தலைப்பைப் பயன்படுத்தவும்
- பிரச்சினையை உருவாக்குவதற்கான துல்லியமான படிகளை விவரிக்கவும்
- குறிப்பிட்ட உதாரணங்களை வழங்கவும் (கோடு துணுக்குகள், திரைச்சிறுத்தங்கள்)
- நீங்கள் கவனித்த நடத்தை மற்றும் எதிர்பார்த்ததை விவரிக்கவும்
- உங்கள் சூழல் விவரங்களைச் சேர்க்கவும் (OS, Python பதிப்பு, உலாவி)
மேம்பாடுகளை பரிந்துரை செய்தல்
மேம்பாட்டு பரிந்துரைகள் எப்போதும் வரவேற்கப்படுகின்றன! பரிந்துரை செய்யும்போது:
- தெளிவான மற்றும் விளக்கமான தலைப்பைப் பயன்படுத்தவும்
- பரிந்துரைக்கப்பட்ட மேம்பாட்டின் விரிவான விளக்கத்தை வழங்கவும்
- இந்த மேம்பாடு ஏன் பயனுள்ளதாக இருக்கும் என்பதை விளக்கவும்
- மற்ற திட்டங்களில் உள்ள இதே போன்ற அம்சங்களை பட்டியலிடவும், பொருத்தமானால்
ஆவணங்களுக்கு பங்களிப்பு
ஆவண மேம்பாடுகள் எப்போதும் பாராட்டப்படுகின்றன:
- தவறுகள் மற்றும் இலக்கண பிழைகளை சரிசெய்யவும்
- விளக்கங்களின் தெளிவை மேம்படுத்தவும்
- காணாமல் போன ஆவணங்களைச் சேர்க்கவும்
- பழமையான தகவல்களைப் புதுப்பிக்கவும்
- உதாரணங்கள் அல்லது பயன்பாடுகளைச் சேர்க்கவும்
கோடுக்கு பங்களிப்பு
கோடுக்கு பங்களிப்புகள் வரவேற்கப்படுகின்றன, அதில்:
- புதிய பாடங்கள் அல்லது பயிற்சிகள்
- பிழை சரிசெய்தல்
- ஏற்கனவே உள்ள நோட்புக் மேம்பாடுகள்
- புதிய தரவுத்தொகுப்புகள் அல்லது உதாரணங்கள்
- வினாடி வினா பயன்பாட்டின் மேம்பாடுகள்
தொடங்குவது எப்படி
முன்பதிவுகள்
பங்களிப்பதற்கு முன், நீங்கள் பின்வருவனவற்றை உறுதிப்படுத்தவும்:
- GitHub கணக்கு
- உங்கள் கணினியில் Git நிறுவப்பட்டுள்ளது
- Python 3.7+ மற்றும் Jupyter நிறுவப்பட்டுள்ளது
- Node.js மற்றும் npm (வினாடி வினா பயன்பாட்டிற்கான பங்களிப்புகளுக்கு)
- பாடத்திட்ட அமைப்பை அறிந்திருத்தல்
விரிவான அமைப்பு வழிகாட்டுதலுக்கு INSTALLATION.md ஐ பார்க்கவும்.
ஃபோர்க் மற்றும் கிளோன்
-
GitHub இல் களஞ்சியத்தை ஃபோர்க் செய்யவும்
-
உங்கள் ஃபோர்க் ஐ உள்ளூர் கணினியில் கிளோன் செய்யவும்:
git clone https://github.com/YOUR-USERNAME/Data-Science-For-Beginners.git cd Data-Science-For-Beginners -
மேலோட்ட ரிமோட்டை சேர்க்கவும்:
git remote add upstream https://github.com/microsoft/Data-Science-For-Beginners.git
கிளையை உருவாக்கவும்
உங்கள் பணிக்கான புதிய கிளையை உருவாக்கவும்:
git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix
கிளை பெயரிடும் விதிமுறைகள்:
feature/- புதிய அம்சங்கள் அல்லது பாடங்கள்fix/- பிழை சரிசெய்தல்docs/- ஆவண மாற்றங்கள்refactor/- கோடு மறுசீரமைப்பு
பங்களிப்பு வழிகாட்டுதல்கள்
பாட உள்ளடக்கத்திற்காக
பாடங்களை பங்களிக்கும்போது அல்லது ஏற்கனவே உள்ளவற்றை மாற்றும்போது:
-
ஏற்கனவே உள்ள அமைப்பைப் பின்பற்றவும்:
- README.md பாட உள்ளடக்கத்துடன்
- பயிற்சிகளுடன் Jupyter நோட்புக்
- பணிக்கான ஒதுக்கீடு (தேவையானால்)
- முன் மற்றும் பின் வினாடி வினா இணைப்புகள்
-
இந்த கூறுகளைச் சேர்க்கவும்:
- தெளிவான கற்றல் நோக்கங்கள்
- படிப்படியாக விளக்கங்கள்
- கருத்துகளுடன் கோடு உதாரணங்கள்
- பயிற்சிகளுக்கான பயிற்சி
- கூடுதல் வளங்களுக்கான இணைப்புகள்
-
அணுகுமுறை உறுதிப்படுத்தவும்:
- தெளிவான, எளிய மொழியைப் பயன்படுத்தவும்
- படங்களுக்கான மாற்று உரையை வழங்கவும்
- கோடு கருத்துகளைச் சேர்க்கவும்
- பல கற்றல் முறைகளை கருத்தில் கொள்ளவும்
Jupyter நோட்புக்குகளுக்காக
-
அனைத்து வெளியீடுகளை அழிக்கவும்:
jupyter nbconvert --clear-output --inplace notebook.ipynb -
விளக்கங்களுடன் மார்க்டவுன் செல்களைச் சேர்க்கவும்
-
ஒரே மாதிரியான வடிவமைப்பைப் பயன்படுத்தவும்:
# 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 -
உங்கள் நோட்புக் முழுமையாக சோதிக்கவும்
Python கோடுக்காக
PEP 8 வடிவமைப்பு வழிகாட்டுதல்களை பின்பற்றவும்:
# 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)
வினாடி வினா பயன்பாட்டிற்கான பங்களிப்புகள்
வினாடி வினா பயன்பாட்டை மாற்றும்போது:
-
உள்ளூரில் சோதிக்கவும்:
cd quiz-app npm install npm run serve -
லின்டர் இயக்கவும்:
npm run lint -
வெற்றிகரமாக கட்டவும்:
npm run build -
Vue.js வடிவமைப்பு வழிகாட்டுதல்களை மற்றும் ஏற்கனவே உள்ள முறைமைகளை பின்பற்றவும்
மொழிபெயர்ப்புகளுக்காக
மொழிபெயர்ப்புகளைச் சேர்க்கும்போது அல்லது புதுப்பிக்கும்போது:
translations/கோப்புறையில் உள்ள அமைப்பைப் பின்பற்றவும்- மொழி குறியீட்டை கோப்புறை பெயராக பயன்படுத்தவும் (எ.கா.,
frபிரெஞ்சுக்காக) - ஆங்கில பதிப்பின் கோப்பு அமைப்பைப் பராமரிக்கவும்
- வினாடி வினா இணைப்புகளை மொழி அளவுருவுடன் புதுப்பிக்கவும்:
?loc=fr - அனைத்து இணைப்புகள் மற்றும் வடிவமைப்புகளைச் சோதிக்கவும்
புல் கோரிக்கை செயல்முறை
சமர்ப்பிப்பதற்கு முன்
-
உங்கள் கிளையை சமீபத்திய மாற்றங்களுடன் புதுப்பிக்கவும்:
git fetch upstream git rebase upstream/main -
உங்கள் மாற்றங்களைச் சோதிக்கவும்:
- மாற்றியமைக்கப்பட்ட அனைத்து நோட்புக்குகளையும் இயக்கவும்
- வினாடி வினா பயன்பாட்டை சோதிக்கவும்
- அனைத்து இணைப்புகள் செயல்படுவதை உறுதிப்படுத்தவும்
- எழுத்துப்பிழைகள் மற்றும் இலக்கண பிழைகளைச் சரிபார்க்கவும்
-
உங்கள் மாற்றங்களை உறுதிப்படுத்தவும்:
git add . git commit -m "Brief description of changes"தெளிவான உறுதிப்படுத்தல் செய்திகளை எழுதவும்:
- நிகழ்காலத்தைப் பயன்படுத்தவும் ("அம்சத்தைச் சேர்க்கவும்" அல்ல "அம்சத்தைச் சேர்த்தது")
- கட்டளையுரு ("கர்சரை நகர்த்தவும்..." அல்ல "கர்சரை நகர்த்துகிறது...")
- முதல் வரியை 72 எழுத்துகளுக்கு வரையறுக்கவும்
- தொடர்புடைய பிரச்சினைகள் மற்றும் புல் கோரிக்கைகளை குறிப்பிடவும்
-
உங்கள் ஃபோர்க்கிற்கு தள்ளவும்:
git push origin feature/your-feature-name
புல் கோரிக்கையை உருவாக்குதல்
- களஞ்சியத்திற்கு செல்லவும்
- "Pull requests" → "New pull request" ஐ கிளிக் செய்யவும்
- "compare across forks" ஐ கிளிக் செய்யவும்
- உங்கள் ஃபோர்க் மற்றும் கிளையைத் தேர்ந்தெடுக்கவும்
- "Create pull request" ஐ கிளிக் செய்யவும்
PR தலைப்பு வடிவம்
தெளிவான, விளக்கமான தலைப்புகளை பின்பற்றவும்:
[Component] Brief description
உதாரணங்கள்:
[Lesson 7] Fix Python notebook import error[Quiz App] Add German translation[Docs] Update README with new prerequisites[Fix] Correct data path in visualization lesson
PR விளக்கம்
உங்கள் PR விளக்கத்தில் சேர்க்கவும்:
- என்ன: நீங்கள் என்ன மாற்றங்களைச் செய்தீர்கள்?
- ஏன்: இந்த மாற்றங்கள் ஏன் தேவையானவை?
- எப்படி: நீங்கள் மாற்றங்களை எவ்வாறு செயல்படுத்தினீர்கள்?
- சோதனை: நீங்கள் மாற்றங்களை எவ்வாறு சோதித்தீர்கள்?
- திரைச்சிறுத்தங்கள்: காட்சி மாற்றங்களுக்கு திரைச்சிறுத்தங்களைச் சேர்க்கவும்
- தொடர்புடைய பிரச்சினைகள்: தொடர்புடைய பிரச்சினைகளை இணைக்கவும் (எ.கா., "Fixes #123")
மதிப்பீட்டு செயல்முறை
- தானியங்கிய சோதனைகள் உங்கள் PR இல் இயங்கும்
- பாதுகாவலர்கள் உங்கள் பங்களிப்பை மதிப்பீடு செய்வார்கள்
- கருத்துகளைத் தீர்க்கவும் மேலும் உறுதிப்படுத்தல்களைச் செய்யவும்
- ஒப்புதல் கிடைத்தவுடன், பாதுகாவலர் உங்கள் PR ஐ இணைப்பார்கள்
உங்கள் PR இணைக்கப்பட்ட பிறகு
-
உங்கள் கிளையை அழிக்கவும்:
git branch -d feature/your-feature-name git push origin --delete feature/your-feature-name -
உங்கள் ஃபோர்க்கை புதுப்பிக்கவும்:
git checkout main git pull upstream main git push origin main
உருவக விதிமுறைகள்
மார்க்டவுன்
-
ஒரே மாதிரியான தலைப்பு நிலைகளைப் பயன்படுத்தவும்
-
பிரிவுகளுக்கு இடையில் காலியாக உள்ள வரிகளைச் சேர்க்கவும்
-
மொழி குறிப்புகளுடன் கோடு தொகுதிகளைப் பயன்படுத்தவும்:
```python import pandas as pd ``` -
படங்களுக்கு மாற்று உரையைச் சேர்க்கவும்:
 -
வரி நீளங்களை நியாயமான அளவில் வைத்திருங்கள் (சுமார் 80-100 எழுத்துகள்)
Python
- PEP 8 வடிவமைப்பு வழிகாட்டுதல்களை பின்பற்றவும்
- பொருத்தமான மாறி பெயர்களைப் பயன்படுத்தவும்
- செயல்பாடுகளுக்கு டாக்ஸ்டிரிங்களைச் சேர்க்கவும்
- தேவையான இடங்களில் வகை குறிப்புகளைச் சேர்க்கவும்:
def process_data(df: pd.DataFrame) -> pd.DataFrame: """Process the input dataframe.""" return df
JavaScript/Vue.js
- Vue.js 2 வடிவமைப்பு வழிகாட்டுதல்களை பின்பற்றவும்
- வழங்கப்பட்ட ESLint அமைப்பைப் பயன்படுத்தவும்
- தொகுதி, மீண்டும் பயன்படுத்தக்கூடிய கூறுகளை எழுதவும்
- சிக்கலான தர்க்கத்திற்கான கருத்துகளைச் சேர்க்கவும்
கோப்பு அமைப்பு
- தொடர்புடைய கோப்புகளை ஒன்றாக வைத்திருங்கள்
- விளக்கமான கோப்பு பெயர்களைப் பயன்படுத்தவும்
- ஏற்கனவே உள்ள கோப்புறை அமைப்பைப் பின்பற்றவும்
- தேவையற்ற கோப்புகளை உறுதிப்படுத்த வேண்டாம் (.DS_Store, .pyc, node_modules, etc.)
பங்களிப்பாளர் உரிமம் ஒப்பந்தம்
இந்த திட்டம் பங்களிப்புகளை மற்றும் பரிந்துரைகளை வரவேற்கிறது. பெரும்பாலான பங்களிப்புகள் உங்களுக்கு பங்களிப்பாளர் உரிமம் ஒப்பந்தம் (CLA) உடன் ஒப்புதல் அளிக்க வேண்டும், இது உங்கள் பங்களிப்பைப் பயன்படுத்த எங்களுக்கு உரிமை உள்ளது என்பதை உறுதிப்படுத்துகிறது. விவரங்களுக்கு, https://cla.microsoft.com ஐ பார்க்கவும்.
நீங்கள் புல் கோரிக்கையை சமர்ப்பிக்கும்போது, CLA-பாட் தானாகவே நீங்கள் CLA வழங்க வேண்டியதா என்பதைத் தீர்மானித்து, PR ஐ சரியான முறையில் அலங்கரிக்கும் (எ.கா., லேபிள், கருத்து). பாட் வழங்கிய வழிகாட்டுதல்களைப் பின்பற்றவும். அனைத்து களஞ்சியங்களிலும் ஒருமுறை மட்டுமே இதைச் செய்ய வேண்டும்.
கேள்விகள்?
- எங்கள் Discord Channel #data-science-for-beginners ஐச் சரிபார்க்கவும்
- எங்கள் Discord community ஐச் சேரவும்
- ஏற்கனவே உள்ள issues மற்றும் pull requests ஐ மதிப்பீடு செய்யவும்
நன்றி!
உங்கள் பங்களிப்புகள் இந்த பாடத்திட்டத்தை அனைவருக்கும் சிறப்பாக மாற்றுகின்றன. பங்களிக்க நேரம் எடுத்துக்கொண்டதற்கு நன்றி!
குறிப்பு:
இந்த ஆவணம் Co-op Translator என்ற AI மொழிபெயர்ப்பு சேவையைப் பயன்படுத்தி மொழிபெயர்க்கப்பட்டுள்ளது. நாங்கள் துல்லியத்திற்காக முயற்சிக்கின்றோம், ஆனால் தானியக்க மொழிபெயர்ப்புகளில் பிழைகள் அல்லது தவறான தகவல்கள் இருக்கக்கூடும் என்பதை தயவுசெய்து கவனத்தில் கொள்ளுங்கள். அதன் தாய்மொழியில் உள்ள மூல ஆவணம் அதிகாரப்பூர்வ ஆதாரமாக கருதப்பட வேண்டும். முக்கியமான தகவல்களுக்கு, தொழில்முறை மனித மொழிபெயர்ப்பு பரிந்துரைக்கப்படுகிறது. இந்த மொழிபெயர்ப்பைப் பயன்படுத்துவதால் ஏற்படும் எந்த தவறான புரிதல்கள் அல்லது தவறான விளக்கங்களுக்கு நாங்கள் பொறுப்பல்ல.