You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
366 lines
19 KiB
366 lines
19 KiB
# ਡਾਟਾ ਸਾਇੰਸ ਫਾਰ ਬਿਗਿਨਰਜ਼ ਵਿੱਚ ਯੋਗਦਾਨ ਪਾਉਣਾ
|
|
|
|
ਡਾਟਾ ਸਾਇੰਸ ਫਾਰ ਬਿਗਿਨਰਜ਼ ਦੇ ਪਾਠਕ੍ਰਮ ਵਿੱਚ ਯੋਗਦਾਨ ਪਾਉਣ ਵਿੱਚ ਦਿਲਚਸਪੀ ਦਿਖਾਉਣ ਲਈ ਧੰਨਵਾਦ! ਅਸੀਂ ਕਮਿਊਨਿਟੀ ਤੋਂ ਯੋਗਦਾਨਾਂ ਦਾ ਸਵਾਗਤ ਕਰਦੇ ਹਾਂ।
|
|
|
|
## ਸੂਚੀ
|
|
|
|
- [ਕੋਡ ਆਫ ਕੰਡਕਟ](../..)
|
|
- [ਮੈਂ ਕਿਵੇਂ ਯੋਗਦਾਨ ਪਾ ਸਕਦਾ ਹਾਂ?](../..)
|
|
- [ਸ਼ੁਰੂਆਤ ਕਰਨਾ](../..)
|
|
- [ਯੋਗਦਾਨ ਦੇ ਨਿਯਮ](../..)
|
|
- [ਪੁਲ ਰਿਕਵੈਸਟ ਪ੍ਰਕਿਰਿਆ](../..)
|
|
- [ਸਟਾਈਲ ਦੇ ਨਿਯਮ](../..)
|
|
- [ਯੋਗਦਾਨ ਲਾਇਸੈਂਸ ਅਗ੍ਰੀਮੈਂਟ](../..)
|
|
|
|
## ਕੋਡ ਆਫ ਕੰਡਕਟ
|
|
|
|
ਇਸ ਪ੍ਰੋਜੈਕਟ ਨੇ [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) ਨੂੰ ਅਪਨਾਇਆ ਹੈ।
|
|
ਹੋਰ ਜਾਣਕਾਰੀ ਲਈ [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) ਵੇਖੋ ਜਾਂ [opencode@microsoft.com](mailto:opencode@microsoft.com) 'ਤੇ ਸਵਾਲ ਜਾਂ ਟਿੱਪਣੀਆਂ ਭੇਜੋ।
|
|
|
|
## ਮੈਂ ਕਿਵੇਂ ਯੋਗਦਾਨ ਪਾ ਸਕਦਾ ਹਾਂ?
|
|
|
|
### ਬੱਗ ਦੀ ਰਿਪੋਰਟਿੰਗ
|
|
|
|
ਬੱਗ ਰਿਪੋਰਟ ਬਣਾਉਣ ਤੋਂ ਪਹਿਲਾਂ, ਮੌਜੂਦਾ ਇਸ਼ੂਜ਼ ਦੀ ਜਾਂਚ ਕਰੋ ਤਾਂ ਜੋ ਦੁਹਰਾਅ ਤੋਂ ਬਚਿਆ ਜਾ ਸਕੇ। ਜਦੋਂ ਤੁਸੀਂ ਬੱਗ ਰਿਪੋਰਟ ਬਣਾਉਂਦੇ ਹੋ, ਤਾਂ ਜ਼ਿਆਦਾ ਤੋਂ ਜ਼ਿਆਦਾ ਵੇਰਵੇ ਸ਼ਾਮਲ ਕਰੋ:
|
|
|
|
- **ਸਪਸ਼ਟ ਅਤੇ ਵਰਣਨਾਤਮਕ ਸਿਰਲੇਖ ਵਰਤੋ**
|
|
- **ਸਮੱਸਿਆ ਨੂੰ ਦੁਹਰਾਉਣ ਦੇ ਸਟੈਪਸ ਦਾ ਸਹੀ ਵਰਣਨ ਦਿਓ**
|
|
- **ਖਾਸ ਉਦਾਹਰਨਾਂ ਦਿਓ** (ਕੋਡ ਸਨਿੱਪਟ, ਸਕ੍ਰੀਨਸ਼ਾਟ)
|
|
- **ਜੋ ਵਿਹਾਰ ਤੁਸੀਂ ਦੇਖਿਆ ਅਤੇ ਜੋ ਤੁਸੀਂ ਉਮੀਦ ਕੀਤੀ ਉਸਦਾ ਵਰਣਨ ਦਿਓ**
|
|
- **ਆਪਣੇ ਵਾਤਾਵਰਣ ਦੇ ਵੇਰਵੇ ਸ਼ਾਮਲ ਕਰੋ** (OS, Python ਵਰਜਨ, ਬ੍ਰਾਊਜ਼ਰ)
|
|
|
|
### ਸੁਧਾਰਾਂ ਦਾ ਸੁਝਾਅ
|
|
|
|
ਸੁਧਾਰਾਂ ਦੇ ਸੁਝਾਅ ਸਵਾਗਤਯੋਗ ਹਨ! ਜਦੋਂ ਤੁਸੀਂ ਸੁਧਾਰਾਂ ਦਾ ਸੁਝਾਅ ਦਿੰਦੇ ਹੋ:
|
|
|
|
- **ਸਪਸ਼ਟ ਅਤੇ ਵਰਣਨਾਤਮਕ ਸਿਰਲੇਖ ਵਰਤੋ**
|
|
- **ਸੁਝਾਏ ਗਏ ਸੁਧਾਰਾਂ ਦਾ ਵਿਸਤ੍ਰਿਤ ਵਰਣਨ ਦਿਓ**
|
|
- **ਇਹ ਸੁਧਾਰ ਕਿਉਂ ਲਾਭਦਾਇਕ ਹੋਵੇਗਾ ਇਹ ਸਮਝਾਓ**
|
|
- **ਕਿਸੇ ਹੋਰ ਪ੍ਰੋਜੈਕਟ ਵਿੱਚ ਮਿਲਦੇ ਜੁਲਦੇ ਫੀਚਰਾਂ ਦੀ ਸੂਚੀ ਦਿਓ, ਜੇ ਲਾਗੂ ਹੋਵੇ**
|
|
|
|
### ਦਸਤਾਵੇਜ਼ ਵਿੱਚ ਯੋਗਦਾਨ
|
|
|
|
ਦਸਤਾਵੇਜ਼ ਵਿੱਚ ਸੁਧਾਰਾਂ ਦੀ ਹਮੇਸ਼ਾ ਕਦਰ ਕੀਤੀ ਜਾਂਦੀ ਹੈ:
|
|
|
|
- **ਟਾਈਪੋ ਅਤੇ ਵਿਆਕਰਣ ਦੀਆਂ ਗਲਤੀਆਂ ਠੀਕ ਕਰੋ**
|
|
- **ਵਿਆਖਿਆਵਾਂ ਦੀ ਸਪਸ਼ਟਤਾ ਵਿੱਚ ਸੁਧਾਰ ਕਰੋ**
|
|
- **ਗੁੰਮ ਦਸਤਾਵੇਜ਼ ਸ਼ਾਮਲ ਕਰੋ**
|
|
- **ਪੁਰਾਣੀ ਜਾਣਕਾਰੀ ਨੂੰ ਅਪਡੇਟ ਕਰੋ**
|
|
- **ਉਦਾਹਰਨਾਂ ਜਾਂ ਵਰਤੋਂ ਦੇ ਕੇਸ ਸ਼ਾਮਲ ਕਰੋ**
|
|
|
|
### ਕੋਡ ਵਿੱਚ ਯੋਗਦਾਨ
|
|
|
|
ਅਸੀਂ ਕੋਡ ਯੋਗਦਾਨਾਂ ਦਾ ਸਵਾਗਤ ਕਰਦੇ ਹਾਂ, ਜਿਵੇਂ ਕਿ:
|
|
|
|
- **ਨਵੇਂ ਪਾਠ ਜਾਂ ਅਭਿਆਸ**
|
|
- **ਬੱਗ ਫਿਕਸ**
|
|
- **ਮੌਜੂਦਾ ਨੋਟਬੁੱਕ ਵਿੱਚ ਸੁਧਾਰ**
|
|
- **ਨਵੇਂ ਡਾਟਾਸੈਟ ਜਾਂ ਉਦਾਹਰਨ**
|
|
- **ਕੁਇਜ਼ ਐਪਲੀਕੇਸ਼ਨ ਵਿੱਚ ਸੁਧਾਰ**
|
|
|
|
## ਸ਼ੁਰੂਆਤ ਕਰਨਾ
|
|
|
|
### ਪੂਰਵ ਸ਼ਰਤਾਂ
|
|
|
|
ਯੋਗਦਾਨ ਪਾਉਣ ਤੋਂ ਪਹਿਲਾਂ, ਇਹ ਯਕੀਨੀ ਬਣਾਓ ਕਿ ਤੁਹਾਡੇ ਕੋਲ:
|
|
|
|
1. GitHub ਖਾਤਾ
|
|
2. ਤੁਹਾਡੇ ਸਿਸਟਮ 'ਤੇ Git ਇੰਸਟਾਲ ਹੈ
|
|
3. Python 3.7+ ਅਤੇ Jupyter ਇੰਸਟਾਲ ਹੈ
|
|
4. Node.js ਅਤੇ npm (ਕੁਇਜ਼ ਐਪ ਯੋਗਦਾਨ ਲਈ)
|
|
5. ਪਾਠਕ੍ਰਮ ਦੀ ਬਣਤਰ ਨਾਲ ਜਾਣੂ
|
|
|
|
ਵੇਰਵੇ ਲਈ [INSTALLATION.md](INSTALLATION.md) ਵੇਖੋ।
|
|
|
|
### ਫੋਰਕ ਅਤੇ ਕਲੋਨ
|
|
|
|
1. GitHub 'ਤੇ **ਰਿਪੋਜ਼ਟਰੀ ਫੋਰਕ ਕਰੋ**
|
|
2. **ਆਪਣੇ ਫੋਰਕ ਨੂੰ ਲੋਕਲ ਕਲੋਨ ਕਰੋ**:
|
|
```bash
|
|
git clone https://github.com/YOUR-USERNAME/Data-Science-For-Beginners.git
|
|
cd Data-Science-For-Beginners
|
|
```
|
|
|
|
3. **ਅਪਸਟ੍ਰੀਮ ਰਿਮੋਟ ਸ਼ਾਮਲ ਕਰੋ**:
|
|
```bash
|
|
git remote add upstream https://github.com/microsoft/Data-Science-For-Beginners.git
|
|
```
|
|
|
|
|
|
### ਬ੍ਰਾਂਚ ਬਣਾਓ
|
|
|
|
ਆਪਣੇ ਕੰਮ ਲਈ ਨਵੀਂ ਬ੍ਰਾਂਚ ਬਣਾਓ:
|
|
|
|
```bash
|
|
git checkout -b feature/your-feature-name
|
|
# or
|
|
git checkout -b fix/your-bug-fix
|
|
```
|
|
|
|
ਬ੍ਰਾਂਚ ਨਾਮਕਰਨ ਦੇ ਨਿਯਮ:
|
|
- `feature/` - ਨਵੇਂ ਫੀਚਰ ਜਾਂ ਪਾਠ
|
|
- `fix/` - ਬੱਗ ਫਿਕਸ
|
|
- `docs/` - ਦਸਤਾਵੇਜ਼ ਵਿੱਚ ਬਦਲਾਅ
|
|
- `refactor/` - ਕੋਡ ਰੀਫੈਕਟਰੀੰਗ
|
|
|
|
## ਯੋਗਦਾਨ ਦੇ ਨਿਯਮ
|
|
|
|
### ਪਾਠ ਸਮੱਗਰੀ ਲਈ
|
|
|
|
ਜਦੋਂ ਪਾਠ ਸ਼ਾਮਲ ਕਰਦੇ ਹੋ ਜਾਂ ਮੌਜੂਦਾ ਪਾਠਾਂ ਨੂੰ ਸੋਧਦੇ ਹੋ:
|
|
|
|
1. **ਮੌਜੂਦਾ ਬਣਤਰ ਦੀ ਪਾਲਣਾ ਕਰੋ**:
|
|
- README.md ਵਿੱਚ ਪਾਠ ਸਮੱਗਰੀ
|
|
- Jupyter ਨੋਟਬੁੱਕ ਵਿੱਚ ਅਭਿਆਸ
|
|
- ਅਸਾਈਨਮੈਂਟ (ਜੇ ਲਾਗੂ ਹੋਵੇ)
|
|
- ਪ੍ਰੀ ਅਤੇ ਪੋਸਟ ਕੁਇਜ਼ ਲਈ ਲਿੰਕ
|
|
|
|
2. **ਇਹ ਤੱਤ ਸ਼ਾਮਲ ਕਰੋ**:
|
|
- ਸਪਸ਼ਟ ਸਿੱਖਣ ਦੇ ਉਦੇਸ਼
|
|
- ਕਦਮ-ਦਰ-ਕਦਮ ਵਿਆਖਿਆਵਾਂ
|
|
- ਟਿੱਪਣੀਆਂ ਨਾਲ ਕੋਡ ਉਦਾਹਰਨ
|
|
- ਅਭਿਆਸ ਲਈ ਪ੍ਰੈਕਟਿਸ
|
|
- ਵਾਧੂ ਸਰੋਤਾਂ ਲਈ ਲਿੰਕ
|
|
|
|
3. **ਪਹੁੰਚਯੋਗਤਾ ਯਕੀਨੀ ਬਣਾਓ**:
|
|
- ਸਪਸ਼ਟ, ਸਧਾਰਨ ਭਾਸ਼ਾ ਵਰਤੋ
|
|
- ਚਿੱਤਰਾਂ ਲਈ alt ਟੈਕਸਟ ਦਿਓ
|
|
- ਕੋਡ ਟਿੱਪਣੀਆਂ ਸ਼ਾਮਲ ਕਰੋ
|
|
- ਵੱਖ-ਵੱਖ ਸਿੱਖਣ ਦੇ ਅੰਦਾਜ਼ਾਂ ਨੂੰ ਧਿਆਨ ਵਿੱਚ ਰੱਖੋ
|
|
|
|
### Jupyter ਨੋਟਬੁੱਕ ਲਈ
|
|
|
|
1. **ਕੋਈ ਵੀ ਆਉਟਪੁੱਟ ਕਲੀਅਰ ਕਰੋ** ਕਮਿਟ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ:
|
|
```bash
|
|
jupyter nbconvert --clear-output --inplace notebook.ipynb
|
|
```
|
|
|
|
2. **ਵਿਆਖਿਆਵਾਂ ਵਾਲੇ ਮਾਰਕਡਾਊਨ ਸੈੱਲ ਸ਼ਾਮਲ ਕਰੋ**
|
|
|
|
3. **ਸਥਿਰ ਫਾਰਮੈਟਿੰਗ ਵਰਤੋ**:
|
|
```python
|
|
# 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
|
|
```
|
|
|
|
4. **ਆਪਣੀ ਨੋਟਬੁੱਕ ਨੂੰ ਪੂਰੀ ਤਰ੍ਹਾਂ ਟੈਸਟ ਕਰੋ** ਜਮ੍ਹਾਂ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ
|
|
|
|
### Python ਕੋਡ ਲਈ
|
|
|
|
[PEP 8](https://www.python.org/dev/peps/pep-0008/) ਸਟਾਈਲ ਗਾਈਡ ਦੀ ਪਾਲਣਾ ਕਰੋ:
|
|
|
|
```python
|
|
# 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)
|
|
```
|
|
|
|
|
|
### ਕੁਇਜ਼ ਐਪ ਯੋਗਦਾਨ ਲਈ
|
|
|
|
ਜਦੋਂ ਕੁਇਜ਼ ਐਪਲੀਕੇਸ਼ਨ ਨੂੰ ਸੋਧਦੇ ਹੋ:
|
|
|
|
1. **ਲੋਕਲ ਟੈਸਟ ਕਰੋ**:
|
|
```bash
|
|
cd quiz-app
|
|
npm install
|
|
npm run serve
|
|
```
|
|
|
|
2. **ਲਿੰਟਰ ਚਲਾਓ**:
|
|
```bash
|
|
npm run lint
|
|
```
|
|
|
|
3. **ਸਫਲਤਾਪੂਰਵਕ ਬਿਲਡ ਕਰੋ**:
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
4. **Vue.js ਸਟਾਈਲ ਗਾਈਡ** ਅਤੇ ਮੌਜੂਦਾ ਪੈਟਰਨ ਦੀ ਪਾਲਣਾ ਕਰੋ
|
|
|
|
### ਅਨੁਵਾਦਾਂ ਲਈ
|
|
|
|
ਜਦੋਂ ਅਨੁਵਾਦ ਸ਼ਾਮਲ ਕਰਦੇ ਹੋ ਜਾਂ ਅਪਡੇਟ ਕਰਦੇ ਹੋ:
|
|
|
|
1. `translations/` ਫੋਲਡਰ ਵਿੱਚ ਬਣਤਰ ਦੀ ਪਾਲਣਾ ਕਰੋ
|
|
2. ਭਾਸ਼ਾ ਕੋਡ ਨੂੰ ਫੋਲਡਰ ਨਾਮ ਵਜੋਂ ਵਰਤੋ (ਜਿਵੇਂ, ਫਰੈਂਚ ਲਈ `fr`)
|
|
3. ਅੰਗਰੇਜ਼ੀ ਵਰਜਨ ਦੇ ਸਮਾਨ ਫਾਇਲ ਬਣਤਰ ਨੂੰ ਰੱਖੋ
|
|
4. ਕੁਇਜ਼ ਲਿੰਕ ਨੂੰ ਭਾਸ਼ਾ ਪੈਰਾਮੀਟਰ ਨਾਲ ਅਪਡੇਟ ਕਰੋ: `?loc=fr`
|
|
5. ਸਾਰੇ ਲਿੰਕ ਅਤੇ ਫਾਰਮੈਟਿੰਗ ਟੈਸਟ ਕਰੋ
|
|
|
|
## ਪੁਲ ਰਿਕਵੈਸਟ ਪ੍ਰਕਿਰਿਆ
|
|
|
|
### ਜਮ੍ਹਾਂ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ
|
|
|
|
1. **ਆਪਣੀ ਬ੍ਰਾਂਚ ਨੂੰ ਤਾਜ਼ਾ ਅਪਡੇਟ ਕਰੋ**:
|
|
```bash
|
|
git fetch upstream
|
|
git rebase upstream/main
|
|
```
|
|
|
|
2. **ਆਪਣੇ ਬਦਲਾਅ ਟੈਸਟ ਕਰੋ**:
|
|
- ਸਾਰੇ ਸੋਧੇ ਗਏ ਨੋਟਬੁੱਕ ਚਲਾਓ
|
|
- ਜੇ ਕੁਇਜ਼ ਐਪ ਸੋਧਿਆ ਗਿਆ ਹੈ ਤਾਂ ਟੈਸਟ ਕਰੋ
|
|
- ਸਾਰੇ ਲਿੰਕ ਦੀ ਜਾਂਚ ਕਰੋ
|
|
- ਟਾਈਪੋ ਅਤੇ ਵਿਆਕਰਣ ਦੀਆਂ ਗਲਤੀਆਂ ਦੀ ਜਾਂਚ ਕਰੋ
|
|
|
|
3. **ਆਪਣੇ ਬਦਲਾਅ ਕਮਿਟ ਕਰੋ**:
|
|
```bash
|
|
git add .
|
|
git commit -m "Brief description of changes"
|
|
```
|
|
|
|
ਸਪਸ਼ਟ ਕਮਿਟ ਸੁਨੇਹੇ ਲਿਖੋ:
|
|
- ਵਰਤਮਾਨ ਕਾਲ ("Add feature" ਨਾ ਕਿ "Added feature")
|
|
- ਆਗਿਆਵਾਚਕ ਮੂਡ ("Move cursor to..." ਨਾ ਕਿ "Moves cursor to...")
|
|
- ਪਹਿਲੀ ਲਾਈਨ ਨੂੰ 72 ਅੱਖਰਾਂ ਤੱਕ ਸੀਮਿਤ ਰੱਖੋ
|
|
- ਜਦੋਂ ਲਾਗੂ ਹੋਵੇ ਤਾਂ ਇਸ਼ੂਜ਼ ਅਤੇ ਪੁਲ ਰਿਕਵੈਸਟ ਦਾ ਹਵਾਲਾ ਦਿਓ
|
|
|
|
4. **ਆਪਣੇ ਫੋਰਕ 'ਤੇ ਪੁਸ਼ ਕਰੋ**:
|
|
```bash
|
|
git push origin feature/your-feature-name
|
|
```
|
|
|
|
|
|
### ਪੁਲ ਰਿਕਵੈਸਟ ਬਣਾਉਣਾ
|
|
|
|
1. [ਰਿਪੋਜ਼ਟਰੀ](https://github.com/microsoft/Data-Science-For-Beginners) 'ਤੇ ਜਾਓ
|
|
2. "Pull requests" → "New pull request" 'ਤੇ ਕਲਿਕ ਕਰੋ
|
|
3. "compare across forks" 'ਤੇ ਕਲਿਕ ਕਰੋ
|
|
4. ਆਪਣਾ ਫੋਰਕ ਅਤੇ ਬ੍ਰਾਂਚ ਚੁਣੋ
|
|
5. "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")
|
|
|
|
### ਸਮੀਖਿਆ ਪ੍ਰਕਿਰਿਆ
|
|
|
|
1. **ਆਟੋਮੈਟਿਕ ਚੈੱਕ** ਤੁਹਾਡੇ PR 'ਤੇ ਚਲਾਏ ਜਾਣਗੇ
|
|
2. **ਮੈਂਟੇਨਰ ਤੁਹਾਡੇ ਯੋਗਦਾਨ ਦੀ ਸਮੀਖਿਆ ਕਰਨਗੇ**
|
|
3. **ਫੀਡਬੈਕ ਦਾ ਜਵਾਬ ਦਿਓ** ਅਤਿਰਿਕਤ ਕਮਿਟ ਕਰਕੇ
|
|
4. ਜਦੋਂ ਮਨਜ਼ੂਰ ਕੀਤਾ ਜਾਂਦਾ ਹੈ, **ਮੈਂਟੇਨਰ ਤੁਹਾਡੇ PR ਨੂੰ ਮਰਜ ਕਰੇਗਾ**
|
|
|
|
### ਤੁਹਾਡੇ PR ਦੇ ਮਰਜ ਹੋਣ ਤੋਂ ਬਾਅਦ
|
|
|
|
1. ਆਪਣੀ ਬ੍ਰਾਂਚ ਨੂੰ ਮਿਟਾਓ:
|
|
```bash
|
|
git branch -d feature/your-feature-name
|
|
git push origin --delete feature/your-feature-name
|
|
```
|
|
|
|
2. ਆਪਣੇ ਫੋਰਕ ਨੂੰ ਅਪਡੇਟ ਕਰੋ:
|
|
```bash
|
|
git checkout main
|
|
git pull upstream main
|
|
git push origin main
|
|
```
|
|
|
|
|
|
## ਸਟਾਈਲ ਦੇ ਨਿਯਮ
|
|
|
|
### ਮਾਰਕਡਾਊਨ
|
|
|
|
- ਸਥਿਰ ਸਿਰਲੇਖ ਪੱਧਰ ਵਰਤੋ
|
|
- ਸੈਕਸ਼ਨਾਂ ਦੇ ਵਿਚਕਾਰ ਖਾਲੀ ਲਾਈਨਾਂ ਸ਼ਾਮਲ ਕਰੋ
|
|
- ਭਾਸ਼ਾ ਨਿਰਧਾਰਕਾਂ ਨਾਲ ਕੋਡ ਬਲਾਕ ਵਰਤੋ:
|
|
````markdown
|
|
```python
|
|
import pandas as pd
|
|
```
|
|
````
|
|
|
|
- ਚਿੱਤਰਾਂ ਲਈ alt ਟੈਕਸਟ ਸ਼ਾਮਲ ਕਰੋ: ``
|
|
- ਲਾਈਨ ਦੀ ਲੰਬਾਈ ਵਾਜਬ ਰੱਖੋ (80-100 ਅੱਖਰਾਂ ਦੇ ਆਸਪਾਸ)
|
|
|
|
### Python
|
|
|
|
- PEP 8 ਸਟਾਈਲ ਗਾਈਡ ਦੀ ਪਾਲਣਾ ਕਰੋ
|
|
- ਅਰਥਪੂਰਨ ਵੈਰੀਏਬਲ ਨਾਮ ਵਰਤੋ
|
|
- ਫੰਕਸ਼ਨ ਲਈ ਡਾਕਸਟ੍ਰਿੰਗ ਸ਼ਾਮਲ ਕਰੋ
|
|
- ਜਿੱਥੇ ਲਾਗੂ ਹੋਵੇ, ਟਾਈਪ ਹਿੰਟ ਸ਼ਾਮਲ ਕਰੋ:
|
|
```python
|
|
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, ਆਦਿ)
|
|
|
|
## ਯੋਗਦਾਨ ਲਾਇਸੈਂਸ ਅਗ੍ਰੀਮੈਂਟ
|
|
|
|
ਇਹ ਪ੍ਰੋਜੈਕਟ ਯੋਗਦਾਨਾਂ ਅਤੇ ਸੁਝਾਅਾਂ ਦਾ ਸਵਾਗਤ ਕਰਦਾ ਹੈ। ਜ਼ਿਆਦਾਤਰ ਯੋਗਦਾਨਾਂ ਲਈ ਤੁਹਾਨੂੰ
|
|
Contributor License Agreement (CLA) ਨਾਲ ਸਹਿਮਤ ਹੋਣਾ ਪਵੇਗਾ ਜੋ ਇਹ ਘੋਸ਼ਣਾ ਕਰਦਾ ਹੈ ਕਿ ਤੁਹਾਡੇ ਕੋਲ
|
|
ਅਧਿਕਾਰ ਹੈ ਅਤੇ ਅਸੀਂ ਤੁਹਾਡੇ ਯੋਗਦਾਨ ਨੂੰ ਵਰਤਣ ਦੇ ਅਧਿਕਾਰ ਪ੍ਰਾਪਤ ਕਰਦੇ ਹਾਂ। ਵੇਰਵੇ ਲਈ,
|
|
https://cla.microsoft.com 'ਤੇ ਜਾਓ।
|
|
|
|
ਜਦੋਂ ਤੁਸੀਂ ਪੁਲ ਰਿਕਵੈਸਟ ਜਮ੍ਹਾਂ ਕਰਦੇ ਹੋ, ਇੱਕ CLA-ਬੋਟ ਆਟੋਮੈਟਿਕ ਤੌਰ 'ਤੇ ਇਹ ਨਿਰਧਾਰਤ ਕਰੇਗਾ ਕਿ
|
|
ਤੁਹਾਨੂੰ CLA ਪ੍ਰਦਾਨ ਕਰਨ ਦੀ ਜ਼ਰੂਰਤ ਹੈ ਜਾਂ ਨਹੀਂ ਅਤੇ PR ਨੂੰ ਸਹੀ ਤੌਰ 'ਤੇ ਸਜਾਵਟ ਕਰੇਗਾ (ਜਿਵੇਂ,
|
|
ਲੇਬਲ, ਟਿੱਪਣੀ)। ਬੋਟ ਦੁਆਰਾ ਦਿੱਤੇ ਗਏ ਨਿਰਦੇਸ਼ਾਂ ਦੀ ਪਾਲਣਾ ਕਰੋ। ਤੁਹਾਨੂੰ ਸਿਰਫ ਇੱਕ ਵਾਰ ਇਹ
|
|
ਕਰਨਾ ਪਵੇਗਾ ਸਾਰੇ ਰਿਪੋਜ਼ਟਰੀਜ਼ ਵਿੱਚ ਜੋ ਸਾਡੇ CLA ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹਨ।
|
|
|
|
## ਸਵਾਲ?
|
|
|
|
- ਸਾਡੇ [Discord Channel #data-science-for-beginners](https://aka.ms/ds4beginners/discord) 'ਤੇ ਜਾਂਚ ਕਰੋ
|
|
- ਸਾਡੇ [Discord community](https://aka.ms/ds4beginners/discord) ਵਿੱਚ ਸ਼ਾਮਲ ਹੋਵੋ
|
|
- ਮੌਜੂਦਾ [issues](https://github.com/microsoft/Data-Science-For-Beginners/issues) ਅਤੇ [pull requests](https://github.com/microsoft/Data-Science-For-Beginners/pulls) ਦੀ ਸਮੀਖਿਆ ਕਰੋ
|
|
|
|
## ਧੰਨਵਾਦ!
|
|
|
|
ਤੁਹਾਡੇ ਯੋਗਦਾਨ ਇਸ ਪਾਠਕ੍ਰਮ ਨੂੰ ਹਰ ਕਿਸੇ ਲਈ ਬਿਹਤਰ ਬਣਾਉਂਦੇ ਹਨ। ਯੋਗਦਾਨ ਪਾਉਣ ਲਈ ਸਮਾਂ ਕੱਢਣ ਲਈ ਧੰਨਵਾਦ!
|
|
|
|
---
|
|
|
|
**ਅਸਵੀਕਰਤੀ**:
|
|
ਇਹ ਦਸਤਾਵੇਜ਼ AI ਅਨੁਵਾਦ ਸੇਵਾ [Co-op Translator](https://github.com/Azure/co-op-translator) ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਅਨੁਵਾਦ ਕੀਤਾ ਗਿਆ ਹੈ। ਜਦੋਂ ਕਿ ਅਸੀਂ ਸਹੀਤਾ ਲਈ ਯਤਨਸ਼ੀਲ ਹਾਂ, ਕਿਰਪਾ ਕਰਕੇ ਧਿਆਨ ਦਿਓ ਕਿ ਸਵੈਚਾਲਿਤ ਅਨੁਵਾਦਾਂ ਵਿੱਚ ਗਲਤੀਆਂ ਜਾਂ ਅਸੁਚੀਤਤਾਵਾਂ ਹੋ ਸਕਦੀਆਂ ਹਨ। ਇਸ ਦੀ ਮੂਲ ਭਾਸ਼ਾ ਵਿੱਚ ਮੌਜੂਦ ਅਸਲ ਦਸਤਾਵੇਜ਼ ਨੂੰ ਅਧਿਕਾਰਤ ਸਰੋਤ ਮੰਨਿਆ ਜਾਣਾ ਚਾਹੀਦਾ ਹੈ। ਮਹੱਤਵਪੂਰਨ ਜਾਣਕਾਰੀ ਲਈ, ਪੇਸ਼ੇਵਰ ਮਨੁੱਖੀ ਅਨੁਵਾਦ ਦੀ ਸਿਫਾਰਸ਼ ਕੀਤੀ ਜਾਂਦੀ ਹੈ। ਇਸ ਅਨੁਵਾਦ ਦੀ ਵਰਤੋਂ ਤੋਂ ਪੈਦਾ ਹੋਣ ਵਾਲੇ ਕਿਸੇ ਵੀ ਗਲਤਫਹਿਮੀ ਜਾਂ ਗਲਤ ਵਿਆਖਿਆ ਲਈ ਅਸੀਂ ਜ਼ਿੰਮੇਵਾਰ ਨਹੀਂ ਹਾਂ। |