Skip to content

Commit 1b92fea

Browse files
jonashaagjonashaag
committed
Need .github?
1 parent 1c91b63 commit 1b92fea

14 files changed

+512
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of
4+
fostering an open and welcoming community, we pledge to respect all people who
5+
contribute through reporting issues, posting feature requests, updating
6+
documentation, submitting pull requests or patches, and other activities.
7+
8+
We are committed to making participation in this project a harassment-free
9+
experience for everyone, regardless of level of experience, gender, gender
10+
identity and expression, sexual orientation, disability, personal appearance,
11+
body size, race, ethnicity, age, religion, or nationality.
12+
13+
Examples of unacceptable behavior by participants include:
14+
15+
* The use of sexualized language or imagery
16+
* Personal attacks
17+
* Trolling or insulting/derogatory comments
18+
* Public or private harassment
19+
* Publishing other's private information, such as physical or electronic
20+
addresses, without explicit permission
21+
* Other unethical or unprofessional conduct
22+
23+
Project maintainers have the right and responsibility to remove, edit, or
24+
reject comments, commits, code, wiki edits, issues, and other contributions
25+
that are not aligned to this Code of Conduct, or to ban temporarily or
26+
permanently any contributor for other behaviors that they deem inappropriate,
27+
threatening, offensive, or harmful.
28+
29+
By adopting this Code of Conduct, project maintainers commit themselves to
30+
fairly and consistently applying these principles to every aspect of managing
31+
this project. Project maintainers who do not follow or enforce the Code of
32+
Conduct may be permanently removed from the project team.
33+
34+
This Code of Conduct applies both within project spaces and in public spaces
35+
when an individual is representing the project or its community.
36+
37+
A working group of community members is committed to promptly addressing any
38+
reported issues. The working group is made up of pandas contributors and users.
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
40+
reported by contacting the working group by e-mail ([email protected]).
41+
Messages sent to this e-mail address will not be publicly visible but only to
42+
the working group members. The working group currently includes
43+
44+
- Safia Abdalla
45+
- Tom Augspurger
46+
- Joris Van den Bossche
47+
- Camille Scott
48+
- Nathaniel Smith
49+
50+
All complaints will be reviewed and investigated and will result in a response
51+
that is deemed necessary and appropriate to the circumstances. Maintainers are
52+
obligated to maintain confidentiality with regard to the reporter of an
53+
incident.
54+
55+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
56+
version 1.3.0, available at
57+
[https://www.contributor-covenant.org/version/1/3/0/][version],
58+
and the [Swift Code of Conduct][swift].
59+
60+
[homepage]: https://www.contributor-covenant.org
61+
[version]: https://www.contributor-covenant.org/version/1/3/0/
62+
[swift]: https://swift.org/community/#code-of-conduct

‎.github/CONTRIBUTING.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing to pandas
2+
3+
A detailed overview on how to contribute can be found in the **[contributing guide](https://pandas.pydata.org/docs/dev/development/contributing.html)**.

‎.github/FUNDING.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
custom: https://pandas.pydata.org/donate.html
2+
github: [numfocus]
3+
tidelift: pypi/pandas

‎.github/ISSUE_TEMPLATE/bug_report.yaml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Bug Report
2+
description: Report incorrect behavior in the pandas library
3+
title: "BUG: "
4+
labels: [Bug, Needs Triage]
5+
6+
body:
7+
- type: checkboxes
8+
id: checks
9+
attributes:
10+
label: Pandas version checks
11+
options:
12+
- label: >
13+
I have checked that this issue has not already been reported.
14+
required: true
15+
- label: >
16+
I have confirmed this bug exists on the
17+
[latest version](https://pandas.pydata.org/docs/whatsnew/index.html) of pandas.
18+
required: true
19+
- label: >
20+
I have confirmed this bug exists on the main branch of pandas.
21+
- type: textarea
22+
id: example
23+
attributes:
24+
label: Reproducible Example
25+
description: >
26+
Please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to
27+
provide a minimal, copy-pastable example.
28+
placeholder: >
29+
import pandas as pd
30+
31+
df = pd.DataFrame(range(5))
32+
33+
...
34+
render: python
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: problem
39+
attributes:
40+
label: Issue Description
41+
description: >
42+
Please provide a description of the issue shown in the reproducible example.
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: expected-behavior
47+
attributes:
48+
label: Expected Behavior
49+
description: >
50+
Please describe or show a code example of the expected behavior.
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: version
55+
attributes:
56+
label: Installed Versions
57+
description: >
58+
Please paste the output of ``pd.show_versions()``
59+
value: >
60+
<details>
61+
62+
63+
Replace this line with the output of pd.show_versions()
64+
65+
66+
</details>
67+
validations:
68+
required: true

‎.github/ISSUE_TEMPLATE/documentation_improvement.yaml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Documentation Improvement
2+
description: Report wrong or missing documentation
3+
title: "DOC: "
4+
labels: [Docs, Needs Triage]
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Pandas version checks
10+
options:
11+
- label: >
12+
I have checked that the issue still exists on the latest versions of the docs
13+
on `main` [here](https://pandas.pydata.org/docs/dev/)
14+
required: true
15+
- type: textarea
16+
id: location
17+
attributes:
18+
label: Location of the documentation
19+
description: >
20+
Please provide the location of the documentation, e.g. "pandas.read_csv" or the
21+
URL of the documentation, e.g.
22+
"https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html"
23+
placeholder: https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: problem
28+
attributes:
29+
label: Documentation problem
30+
description: >
31+
Please provide a description of what documentation you believe needs to be fixed/improved
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: suggested-fix
36+
attributes:
37+
label: Suggested fix for documentation
38+
description: >
39+
Please explain the suggested fix and **why** it's better than the existing documentation
40+
validations:
41+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
3+
name: Feature Request
4+
about: Suggest an idea for pandas
5+
title: "ENH:"
6+
labels: "Enhancement, Needs Triage"
7+
8+
---
9+
10+
#### Is your feature request related to a problem?
11+
12+
[this should provide a description of what the problem is, e.g. "I wish I could use pandas to do [...]"]
13+
14+
#### Describe the solution you'd like
15+
16+
[this should provide a description of the feature request, e.g. "`DataFrame.foo` should get a new parameter `bar` that [...]", try to write a docstring for the desired feature]
17+
18+
#### API breaking implications
19+
20+
[this should provide a description of how this feature will affect the API]
21+
22+
#### Describe alternatives you've considered
23+
24+
[this should provide a description of any alternative solutions or features you've considered]
25+
26+
#### Additional context
27+
28+
[add any other context, code examples, or references to existing implementations about the feature request here]
29+
30+
```python
31+
# Your code here, if applicable
32+
33+
```

‎.github/ISSUE_TEMPLATE/installation_issue.yaml

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Installation Issue
2+
description: Report issues installing the pandas library on your system
3+
title: "BUILD: "
4+
labels: [Build, Needs Triage]
5+
6+
body:
7+
- type: checkboxes
8+
id: checks
9+
attributes:
10+
label: Installation check
11+
options:
12+
- label: >
13+
I have read the [installation guide](https://pandas.pydata.org/pandas-docs/stable/getting_started/install.html#installing-pandas).
14+
required: true
15+
- type: input
16+
id: platform
17+
attributes:
18+
label: Platform
19+
description: >
20+
Please provide the output of ``import platform; print(platform.platform())``
21+
validations:
22+
required: true
23+
- type: dropdown
24+
id: method
25+
attributes:
26+
label: Installation Method
27+
description: >
28+
Please provide how you tried to install pandas from a clean environment.
29+
options:
30+
- pip install
31+
- conda install
32+
- apt-get install
33+
- Built from source
34+
- Other
35+
validations:
36+
required: true
37+
- type: input
38+
id: pandas
39+
attributes:
40+
label: pandas Version
41+
description: >
42+
Please provide the version of pandas you are trying to install.
43+
validations:
44+
required: true
45+
- type: input
46+
id: python
47+
attributes:
48+
label: Python Version
49+
description: >
50+
Please provide the installed version of Python.
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: logs
55+
attributes:
56+
label: Installation Logs
57+
description: >
58+
If possible, please copy and paste the installation logs when attempting to install pandas.
59+
value: >
60+
<details>
61+
62+
63+
Replace this line with the installation logs.
64+
65+
66+
</details>

‎.github/ISSUE_TEMPLATE/performance_issue.yaml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Performance Issue
2+
description: Report slow performance or memory issues when running pandas code
3+
title: "PERF: "
4+
labels: [Performance, Needs Triage]
5+
6+
body:
7+
- type: checkboxes
8+
id: checks
9+
attributes:
10+
label: Pandas version checks
11+
options:
12+
- label: >
13+
I have checked that this issue has not already been reported.
14+
required: true
15+
- label: >
16+
I have confirmed this issue exists on the
17+
[latest version](https://pandas.pydata.org/docs/whatsnew/index.html) of pandas.
18+
required: true
19+
- label: >
20+
I have confirmed this issue exists on the main branch of pandas.
21+
- type: textarea
22+
id: example
23+
attributes:
24+
label: Reproducible Example
25+
description: >
26+
Please provide a minimal, copy-pastable example that quantifies
27+
[slow runtime](https://docs.python.org/3/library/timeit.html) or
28+
[memory](https://pypi.org/project/memory-profiler/) issues.
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: version
33+
attributes:
34+
label: Installed Versions
35+
description: >
36+
Please paste the output of ``pd.show_versions()``
37+
value: >
38+
<details>
39+
40+
41+
Replace this line with the output of pd.show_versions()
42+
43+
44+
</details>
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: prior-performance
49+
attributes:
50+
label: Prior Performance
51+
description: >
52+
If applicable, please provide the prior version of pandas and output
53+
of the same reproducible example where the performance issue did not exist.

‎.github/ISSUE_TEMPLATE/submit_question.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Submit Question
2+
description: Ask a general question about pandas
3+
title: "QST: "
4+
labels: [Usage Question, Needs Triage]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Since [StackOverflow](https://stackoverflow.com) is better suited towards answering
11+
usage questions, we ask that all usage questions are first asked on StackOverflow.
12+
- type: checkboxes
13+
attributes:
14+
label: Research
15+
options:
16+
- label: >
17+
I have searched the [[pandas] tag](https://stackoverflow.com/questions/tagged/pandas)
18+
on StackOverflow for similar questions.
19+
required: true
20+
- label: >
21+
I have asked my usage related question on [StackOverflow](https://stackoverflow.com).
22+
required: true
23+
- type: input
24+
id: question-link
25+
attributes:
26+
label: Link to question on StackOverflow
27+
validations:
28+
required: true
29+
- type: markdown
30+
attributes:
31+
value: ---
32+
- type: textarea
33+
id: question
34+
attributes:
35+
label: Question about pandas
36+
description: >
37+
**Note**: If you'd still like to submit a question, please read [this guide](
38+
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
39+
how to provide the necessary information for us to reproduce your question.
40+
placeholder: |
41+
```python
42+
# Your code here, if applicable
43+
44+
```

‎.github/PULL_REQUEST_TEMPLATE.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- [ ] closes #xxxx (Replace xxxx with the Github issue number)
2+
- [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature
3+
- [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit).
4+
- [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.

‎.github/SECURITY.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
To report a security vulnerability to pandas, please go to https://tidelift.com/security and see the instructions there.

0 commit comments

Comments
 (0)