Skip to content

Commit a76c8cd

Browse files
Ranjana BabuRanjana Babu
authored andcommitted
add contribution_plan.md file
1 parent 592a41a commit a76c8cd

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

contribution_plan.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
## 1. Basic Information
2+
3+
- **Project Name:** pandas
4+
- **GitHub URL:** [https://github.com/pandas-dev/pandas](https://github.com/pandas-dev/pandas)
5+
- **Primary Language(s):**
6+
- Python (core language)
7+
- C / Cython (for performance-critical components)
8+
9+
- **What is the project used for?**
10+
pandas is a powerful, open-source library used for:
11+
- Data manipulation and analysis
12+
- Working with structured data (like CSV, Excel, SQL, JSON)
13+
- Offering key data structures: `DataFrame` and `Series`
14+
- Enabling fast, flexible operations for data cleaning, filtering, grouping, merging, and more
15+
It's widely used in data science, machine learning, finance, and research.
16+
17+
---
18+
19+
## 2. Contribution Guidelines
20+
21+
- **Are there clear steps in a CONTRIBUTING.md file?**
22+
No
23+
24+
- **Is there a Code of Conduct?**
25+
✅ Yes, the project follows a [Code of Conduct](https://github.com/pandas-dev/pandas/blob/main/.github/CODE_OF_CONDUCT.md) based on the Contributor Covenant to ensure a welcoming and respectful community.
26+
27+
- **Is a CLA (Contributor License Agreement) needed?**
28+
❌ No Contributor License Agreement is required for contributing to pandas.
29+
30+
- **Are first-time contributors welcomed?**
31+
✅ Yes, very much! The project:
32+
- Labels beginner-friendly issues (`good first issue`)
33+
- Offers clear contribution steps
34+
- Encourages community interaction on GitHub discussions and issues
35+
36+
---
37+
38+
## 3. Environment Setup
39+
40+
- **How do you set up the project locally?**
41+
42+
1. **Install Anaconda**
43+
- Download from [https://www.anaconda.com](https://www.anaconda.com)
44+
45+
2. **Create a conda environment**
46+
conda create -n pandas-dev python=3.10 -y
47+
conda activate pandas-dev
48+
49+
50+
3. **Clone the GitHub repository**
51+
git clone https://github.com/pandas-dev/pandas.git
52+
cd pandas
53+
54+
4. **Install dependencies**
55+
pip install -r requirements-dev.txt
56+
57+
5. **(Optional) Build pandas from source**
58+
python setup.py build_ext --inplace
59+
60+
6. **(Optional) Run tests**
61+
pytest pandas
62+
63+
- **Any dependencies or setup steps?**
64+
Yes — dependencies are managed through `requirements-dev.txt` and include:
65+
- `numpy`, `cython`
66+
- `pytest`, `mypy`, `black`, `flake8`
67+
- `isort`, `versioneer`, and others required for linting, testing, and building

0 commit comments

Comments
 (0)