Skip to content

Commit f3bb494

Browse files
authored
Merge pull request #133 from a5chin/feature/pr-template
Add Pull Request Template
2 parents 7a5895d + 484722c commit f3bb494

File tree

5 files changed

+662
-8
lines changed

5 files changed

+662
-8
lines changed

.github/pull_request_template.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
## Summary
2+
3+
<!-- Briefly describe what this PR does and why it's needed -->
4+
5+
6+
## Type of Change
7+
8+
- [ ] Bug fix (non-breaking change which fixes an issue)
9+
- [ ] New feature (non-breaking change which adds functionality)
10+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
11+
- [ ] Refactoring (code improvement without changing functionality)
12+
- [ ] Documentation update
13+
- [ ] Performance improvement
14+
- [ ] CI/CD or tooling change
15+
- [ ] Dependency update
16+
17+
## Related Issues
18+
19+
<!-- Link to related issues (e.g., Fixes #123, Relates to #456) -->
20+
21+
Fixes #
22+
Relates to #
23+
24+
## Changes Made
25+
26+
<!-- List the main changes in this PR -->
27+
28+
-
29+
-
30+
-
31+
32+
## Testing
33+
34+
<!-- Describe how you tested these changes -->
35+
36+
**Test Commands Run:**
37+
- [ ] `uv run nox -s test` (all tests passed, coverage ≥ 75%)
38+
- [ ] `uv run nox -s lint -- --pyright --ruff` (no errors)
39+
- [ ] `uv run nox -s fmt` (formatting applied)
40+
- [ ] `uv run pre-commit run --all-files` (all hooks passed)
41+
42+
**Testing Notes:**
43+
<!-- Add any relevant testing details, edge cases covered, or manual testing steps -->
44+
45+
46+
## Pre-Submission Checklist
47+
48+
<!-- Verify ALL items before requesting review -->
49+
50+
### Code Quality & Tests
51+
- [ ] All functions/methods have type hints
52+
- [ ] Code has docstrings for public APIs
53+
- [ ] New test files follow `test__*.py` naming convention
54+
- [ ] Tests are meaningful and cover edge cases
55+
56+
### Dependencies & Documentation
57+
- [ ] Used `uv add` for dependencies (not manual `pyproject.toml` edits)
58+
- [ ] `uv.lock` is updated and committed
59+
- [ ] Documentation updated (`README.md`, `CLAUDE.md`, or `docs/` if applicable)
60+
- [ ] Environment variables documented (if new ones added to `Settings`)
61+
62+
### Configuration Changes
63+
- [ ] No configuration changes
64+
- OR if config changed:
65+
- [ ] `.env` updated with new variables and defaults
66+
- [ ] `Settings` class updated
67+
- [ ] No secrets committed (use `.env.local` for sensitive values)
68+
69+
## Breaking Changes
70+
71+
- [ ] This PR does NOT include breaking changes
72+
73+
<!-- If there ARE breaking changes, describe them below -->
74+
75+
**Breaking Changes Details:**
76+
<!-- Describe what breaks, migration path, and affected users/systems -->
77+
78+
79+
## Additional Notes
80+
81+
<!-- Add screenshots, performance notes, deployment instructions, or reviewer guidance if needed -->

CLAUDE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,11 @@ GitHub Actions workflows in `.github/workflows/`:
242242

243243
All workflows use the same nox commands as local development.
244244

245+
## Pull Request Process
246+
247+
For comprehensive contribution guidelines, including detailed steps for creating and reviewing Pull Requests, please refer to [CONTRIBUTING.md](CONTRIBUTING.md) in the repository root.
248+
249+
**Code of Conduct**: All contributors must follow our [Code of Conduct](CODE_OF_CONDUCT.md). We maintain a welcoming, inclusive, and harassment-free environment for everyone.
245250
## Environment Variables
246251

247252
Critical environment variables (set in `.env.local`):

CODE_OF_CONDUCT.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributor Covenant 3.0 Code of Conduct
2+
3+
## Our Pledge
4+
5+
We pledge to make our community welcoming, safe, and equitable for all.
6+
7+
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
8+
9+
## Encouraged Behaviors
10+
11+
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
12+
13+
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
14+
15+
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
16+
2. Engaging **kindly and honestly** with others.
17+
3. Respecting **different viewpoints** and experiences.
18+
4. **Taking responsibility** for our actions and contributions.
19+
5. Gracefully giving and accepting **constructive feedback**.
20+
6. Committing to **repairing harm** when it occurs.
21+
7. Behaving in other ways that promote and sustain the **well-being of our community**.
22+
23+
24+
## Restricted Behaviors
25+
26+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
27+
28+
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
29+
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
30+
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
31+
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
32+
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
33+
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
34+
7. Behaving in other ways that **threaten the well-being** of our community.
35+
36+
### Other Restrictions
37+
38+
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
39+
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
40+
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
41+
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
42+
43+
44+
## Reporting an Issue
45+
46+
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
47+
48+
When an incident does occur, it is important to report it promptly. To report a possible violation.
49+
50+
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
51+
52+
53+
## Addressing and Repairing Harm
54+
55+
**[NOTE: The remedies and repairs outlined below are suggestions based on best practices in code of conduct enforcement. If your community has its own established enforcement process, be sure to edit this section to describe your own policies.]**
56+
57+
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
58+
59+
1) Warning
60+
1) Event: A violation involving a single incident or series of incidents.
61+
2) Consequence: A private, written warning from the Community Moderators.
62+
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
63+
2) Temporarily Limited Activities
64+
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
65+
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
66+
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
67+
3) Temporary Suspension
68+
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
69+
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
70+
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
71+
4) Permanent Ban
72+
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
73+
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
74+
3) Repair: There is no possible repair in cases of this severity.
75+
76+
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
77+
78+
79+
## Scope
80+
81+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
82+
83+
84+
## Attribution
85+
86+
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
87+
88+
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
89+
90+
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).
91+

0 commit comments

Comments
 (0)