Skip to content

Commit 2a7f3c0

Browse files
igerberigerber
authored
Merge pull request igerber#388 from igerber/gh-community-files
chore: add community standards files; remove stray BRIEFING.md
2 parents 81d0eda + 9dc655c commit 2a7f3c0

6 files changed

Lines changed: 314 additions & 80 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
name: Bug report
2+
description: Report a defect or unexpected behavior in diff-diff
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to file a bug report. Please fill out the
10+
sections below so the maintainer can reproduce the issue quickly.
11+
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description: A clear and concise description of the bug.
17+
placeholder: When I call `DifferenceInDifferences.fit(...)` with ..., the result has ...
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: reproducer
23+
attributes:
24+
label: Minimal reproducer
25+
description: |
26+
Smallest possible code snippet that reproduces the issue. Inline data is
27+
ideal; if you must attach a file, please scrub any sensitive content.
28+
render: python
29+
placeholder: |
30+
import numpy as np
31+
import pandas as pd
32+
from diff_diff import DifferenceInDifferences
33+
34+
df = pd.DataFrame({...})
35+
est = DifferenceInDifferences()
36+
results = est.fit(df, outcome='y', treatment='treated', time='post')
37+
print(results.att)
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: expected
43+
attributes:
44+
label: Expected behavior
45+
description: What did you expect to happen?
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: actual
51+
attributes:
52+
label: Actual behavior
53+
description: What actually happened? Include the full traceback if applicable.
54+
render: shell
55+
validations:
56+
required: true
57+
58+
- type: input
59+
id: version
60+
attributes:
61+
label: diff-diff version
62+
description: Output of `python -c "import diff_diff; print(diff_diff.__version__)"`
63+
placeholder: "3.3.1"
64+
validations:
65+
required: true
66+
67+
- type: input
68+
id: python-version
69+
attributes:
70+
label: Python version
71+
placeholder: "3.11"
72+
validations:
73+
required: true
74+
75+
- type: dropdown
76+
id: backend
77+
attributes:
78+
label: Backend
79+
description: |
80+
Run `python -c "from diff_diff import HAS_RUST_BACKEND; print(HAS_RUST_BACKEND)"`
81+
options:
82+
- "Rust (HAS_RUST_BACKEND=True)"
83+
- "Pure Python (HAS_RUST_BACKEND=False)"
84+
- "Not sure"
85+
validations:
86+
required: true
87+
88+
- type: dropdown
89+
id: os
90+
attributes:
91+
label: Operating system
92+
options:
93+
- macOS (Apple Silicon)
94+
- macOS (Intel)
95+
- Linux (x86_64)
96+
- Linux (aarch64)
97+
- Windows
98+
- Other
99+
validations:
100+
required: true
101+
102+
- type: textarea
103+
id: additional
104+
attributes:
105+
label: Additional context
106+
description: Anything else that might be relevant — relevant references, similar issues, workarounds you tried, etc.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Feature request
2+
description: Suggest a new estimator, diagnostic, or capability
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature. The maintainer prioritizes additions
10+
that have a clear methodological foundation (paper, R package, or
11+
established convention) and a concrete use case.
12+
13+
- type: textarea
14+
id: use-case
15+
attributes:
16+
label: Use case
17+
description: |
18+
What problem are you trying to solve? Describe the analysis, design, or
19+
workflow that motivates this request.
20+
placeholder: |
21+
I'm running a staggered DiD on retailer-week panel data with treatment
22+
intensity that varies continuously, and I currently have to ...
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: proposed-api
28+
attributes:
29+
label: Proposed API or behavior
30+
description: |
31+
Sketch what calling the feature would look like. A code example is
32+
ideal, even if rough.
33+
render: python
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: references
39+
attributes:
40+
label: Methodology references
41+
description: |
42+
If this implements a published method, link to the paper(s) and/or any
43+
existing R / Python implementation. Estimator additions generally need
44+
a paper citation.
45+
placeholder: |
46+
- Paper: Author et al. (Year), "Title", Journal. DOI / arXiv link.
47+
- Existing implementation: e.g. R package `did`, function `att_gt()`
48+
validations:
49+
required: false
50+
51+
- type: textarea
52+
id: alternatives
53+
attributes:
54+
label: Alternatives considered
55+
description: |
56+
What workarounds exist today? Why aren't they sufficient?
57+
validations:
58+
required: false
59+
60+
- type: textarea
61+
id: additional
62+
attributes:
63+
label: Additional context
64+
description: Anything else relevant — related estimators in diff-diff, scope concerns, etc.

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,3 +98,7 @@ analysis/
9898
# Replication data (local only, not for distribution)
9999
replication_data/
100100
_scratch/
101+
102+
# Per-initiative briefing notes (local only, not for distribution)
103+
BRIEFING.md
104+
briefings/

‎BRIEFING.md‎

Lines changed: 0 additions & 80 deletions
This file was deleted.

‎CODE_OF_CONDUCT.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of unacceptable behavior may be reported to the project maintainer via GitHub at [@igerber](https://github.com/igerber). All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76+
77+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
81+
[Mozilla CoC]: https://github.com/mozilla/diversity
82+
[FAQ]: https://www.contributor-covenant.org/faq
83+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)