Skip to content

Commit 93d82e3

Browse files
MishaKavclaude
andauthored
Add community health files [skip ci] (#224)
* Add community health files to improve GitHub Community Standards This adds all recommended community health files: - CONTRIBUTING.md - Developer contribution guide with setup and workflow - CODE_OF_CONDUCT.md - Contributor Covenant 2.1 - SECURITY.md - Security vulnerability reporting guidelines - SUPPORT.md - Help and support resources - Issue templates (bug report, feature request) - Simplified forms for users - Pull request template - Minimal checklist for contributors All files are kept minimal and developer-friendly to avoid overwhelming contributors. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> * Fix SUPPORT.md based on review feedback - Fix examples reference to point to README's Usage Examples section - Remove Discussions reference as they are not enabled Addresses Copilot review comments on PR #224 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent fc0481e commit 93d82e3

8 files changed

Lines changed: 393 additions & 0 deletions

File tree

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: '[Bug]: '
4+
labels: ['bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting! Please describe the issue briefly.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: What's the bug?
15+
description: What happened vs what you expected?
16+
placeholder: 'The action did X but I expected Y...'
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: workflow
22+
attributes:
23+
label: Your workflow
24+
description: Paste your workflow configuration (optional but helpful)
25+
placeholder: |
26+
```yaml
27+
- uses: MishaKav/pytest-coverage-comment@main
28+
with:
29+
...
30+
```
31+
render: yaml
32+
validations:
33+
required: false
34+
35+
- type: textarea
36+
id: logs
37+
attributes:
38+
label: Error logs
39+
description: Any error messages from the workflow (optional)
40+
placeholder: Paste error logs here...
41+
render: shell
42+
validations:
43+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Documentation
4+
url: https://github.com/MishaKav/pytest-coverage-comment#readme
5+
about: Check the README for usage examples and configuration options
6+
- name: Security Vulnerability
7+
url: https://github.com/MishaKav/pytest-coverage-comment/security/advisories/new
8+
about: Report a security vulnerability privately
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: '[Feature]: '
4+
labels: ['enhancement']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for your suggestion!
10+
11+
- type: textarea
12+
id: feature
13+
attributes:
14+
label: What feature would you like?
15+
description: Describe what you'd like to see
16+
placeholder: "I'd like the action to..."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: why
22+
attributes:
23+
label: Why do you need this?
24+
description: What problem does this solve?
25+
placeholder: 'This would help me...'
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: example
31+
attributes:
32+
label: Example (optional)
33+
description: Show how you'd use it
34+
placeholder: |
35+
```yaml
36+
- uses: MishaKav/pytest-coverage-comment@main
37+
with:
38+
new-option: value
39+
```
40+
render: yaml
41+
validations:
42+
required: false

‎.github/pull_request_template.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## What does this PR do?
2+
3+
<!-- Brief description of your changes -->
4+
5+
## Related Issue
6+
7+
Closes #
8+
9+
## Checklist
10+
11+
- [ ] Tested locally
12+
- [ ] Ran `npm run all`
13+
- [ ] Updated docs (if needed)

‎CODE_OF_CONDUCT.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
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, caste, color, religion, or sexual
10+
identity 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 for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement via GitHub issues
63+
or by contacting the project maintainer.
64+
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing to pytest-coverage-comment
2+
3+
Thanks for your interest in contributing! This document provides guidelines for contributing to this project.
4+
5+
## Development Setup
6+
7+
1. **Fork and clone** the repository
8+
2. **Install dependencies**:
9+
```bash
10+
npm install
11+
```
12+
3. **Make your changes** in the `src/` directory
13+
4. **Build and test**:
14+
```bash
15+
npm run all # Run lint, format, and build
16+
# Or run individually:
17+
npm run lint # Check code style
18+
npm run format-check # Check formatting
19+
npm run build # Bundle the action
20+
```
21+
22+
## Making Changes
23+
24+
1. **Create a branch** from `main`:
25+
26+
```bash
27+
git checkout -b feature/your-feature-name
28+
```
29+
30+
2. **Follow code style**:
31+
- Run `npm run lint` before committing
32+
- Run `npm run format` to auto-format code
33+
- Follow existing code patterns
34+
35+
3. **Test your changes**:
36+
- Use `src/cli.js` for local testing
37+
- Test with actual coverage files when possible
38+
39+
4. **Commit your changes**:
40+
- Use clear, descriptive commit messages
41+
- Reference issue numbers when applicable
42+
43+
5. **Submit a Pull Request**:
44+
- Fill out the PR template
45+
- Link to related issues
46+
- Ensure all checks pass
47+
48+
## Reporting Issues
49+
50+
- **Bug reports**: Use the bug report template
51+
- **Feature requests**: Use the feature request template
52+
- **Questions**: Check existing issues or open a discussion
53+
54+
## Code Review Process
55+
56+
- Maintainers will review PRs as time permits
57+
- Address any requested changes
58+
- Once approved, maintainers will merge your PR
59+
60+
## Questions?
61+
62+
See [SUPPORT.md](SUPPORT.md) for ways to get help.
63+
64+
---
65+
66+
**Thank you for contributing!** 🎉

‎SECURITY.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability in pytest-coverage-comment, please report it privately to help keep the community safe.
6+
7+
### How to Report
8+
9+
**Please do not report security vulnerabilities through public GitHub issues.**
10+
11+
Instead, please use one of these methods:
12+
13+
1. **GitHub Security Advisories** (preferred):
14+
- Go to the [Security tab](https://github.com/MishaKav/pytest-coverage-comment/security/advisories)
15+
- Click "Report a vulnerability"
16+
- Fill out the form with details
17+
18+
2. **Email**: Contact the maintainer directly through GitHub profile
19+
20+
### What to Include
21+
22+
- Description of the vulnerability
23+
- Steps to reproduce the issue
24+
- Potential impact
25+
- Suggested fix (if any)
26+
27+
### Response Timeline
28+
29+
- **Acknowledgment**: Within 48 hours
30+
- **Initial assessment**: Within 1 week
31+
- **Fix and disclosure**: Coordinated with reporter
32+
33+
## Supported Versions
34+
35+
We release security updates for the latest version. Please ensure you're using the most recent release.
36+
37+
| Version | Supported |
38+
| ------- | ------------------ |
39+
| Latest | :white_check_mark: |
40+
| Older | :x: |
41+
42+
## Security Best Practices
43+
44+
When using this action in your workflows:
45+
46+
- Pin action versions to specific tags (e.g., `@v1.2.3`) rather than branches
47+
- Review action permissions in your workflow files
48+
- Keep dependencies up to date
49+
- Limit token permissions to the minimum required
50+
51+
Thank you for helping keep pytest-coverage-comment secure!

0 commit comments

Comments
 (0)