Skip to content

Commit 3510d99

Browse files
docs: add community health files (#1)
* docs: add SECURITY.md with vulnerability reporting policy * docs: add CODE_OF_CONDUCT.md (Contributor Covenant v2.1) * docs: add bug report issue template * docs: add feature request issue template * docs: add pull request template
1 parent b1b5e4a commit 3510d99

5 files changed

Lines changed: 182 additions & 0 deletions

File tree

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug Report
3+
about: Report something that is not working correctly
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
## Description
10+
11+
A clear description of what the bug is.
12+
13+
## Steps to reproduce
14+
15+
1. Go to ...
16+
2. Click on ...
17+
3. Observe ...
18+
19+
## Expected behavior
20+
21+
What you expected to happen.
22+
23+
## Actual behavior
24+
25+
What actually happened.
26+
27+
## Environment
28+
29+
- **OS**: (e.g., Fedora 43, Ubuntu 24.04)
30+
- **Python version**: (e.g., 3.14)
31+
- **TextTools version/commit**: (e.g., main branch, commit abc1234)
32+
33+
## Screenshots
34+
35+
If applicable, add screenshots to help explain the problem.
36+
37+
## Additional context
38+
39+
Any other information that might help diagnose the issue.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea or improvement
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
## Problem or motivation
10+
11+
What problem does this solve, or what workflow does it improve?
12+
13+
## Proposed solution
14+
15+
Describe how you'd like it to work.
16+
17+
## Alternatives considered
18+
19+
Any alternative approaches you've thought about.
20+
21+
## Additional context
22+
23+
Mockups, examples from other tools, or anything else that helps explain the request.

.github/pull_request_template.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## What does this PR do?
2+
3+
Brief description of the changes.
4+
5+
## Related issue
6+
7+
Closes #(issue number)
8+
9+
## Type of change
10+
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Refactoring (no functional changes)
14+
- [ ] Documentation update
15+
- [ ] Test improvement
16+
- [ ] CI/build change
17+
18+
## Testing
19+
20+
- [ ] Existing tests pass (`pytest tests/`)
21+
- [ ] New tests added for changed behavior
22+
- [ ] Type checking passes (`mypy src/`)
23+
24+
## Checklist
25+
26+
- [ ] Code follows the MVVM architecture (see CLAUDE.md)
27+
- [ ] No Qt imports in model or service layers
28+
- [ ] UI changes use Qt Designer `.ui` files (no programmatic layout)
29+
- [ ] Black and isort formatting applied

CODE_OF_CONDUCT.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment:
18+
19+
- Using welcoming and inclusive language
20+
- Being respectful of differing viewpoints and experiences
21+
- Gracefully accepting constructive criticism
22+
- Focusing on what is best for the community
23+
- Showing empathy towards other community members
24+
25+
Examples of unacceptable behavior:
26+
27+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
28+
- Trolling, insulting or derogatory comments, and personal or political attacks
29+
- Public or private harassment
30+
- Publishing others' private information without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a professional setting
32+
33+
## Enforcement Responsibilities
34+
35+
Community leaders are responsible for clarifying and enforcing our standards of
36+
acceptable behavior and will take appropriate and fair corrective action in
37+
response to any behavior that they deem inappropriate, threatening, offensive,
38+
or harmful.
39+
40+
## Scope
41+
42+
This Code of Conduct applies within all community spaces, and also applies when
43+
an individual is officially representing the community in public spaces.
44+
45+
## Enforcement
46+
47+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
48+
reported to the community leaders responsible for enforcement via GitHub issues
49+
or direct contact with the maintainer.
50+
51+
All complaints will be reviewed and investigated promptly and fairly.
52+
53+
## Attribution
54+
55+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
56+
version 2.1, available at
57+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

SECURITY.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability in TextTools, please report it responsibly.
6+
7+
**Do not open a public issue.** Instead, email the maintainer directly or use GitHub's private vulnerability reporting feature (Security tab > "Report a vulnerability").
8+
9+
### What to include
10+
11+
- Description of the vulnerability
12+
- Steps to reproduce
13+
- Affected version(s)
14+
- Any potential impact you've identified
15+
16+
### Response timeline
17+
18+
- **Acknowledgment**: within 48 hours
19+
- **Assessment**: within 1 week
20+
- **Fix**: depends on severity, but we aim for prompt resolution
21+
22+
### Supported versions
23+
24+
| Version | Supported |
25+
|---------|-----------|
26+
| Latest on `main` | Yes |
27+
| Older commits | No |
28+
29+
## Scope
30+
31+
TextTools is a local desktop application. Security concerns most likely involve:
32+
- File handling vulnerabilities (path traversal, symlink attacks)
33+
- Unsafe deserialization of user-provided data
34+
- Dependencies with known CVEs

0 commit comments

Comments
 (0)