Skip to content

Commit 9ee14f2

Browse files
docs: add community governance files
* docs: Add CODE_OF_CONDUCT.md and SECURITY.md Adds standard community health files to the project. - CODE_OF_CONDUCT.md is based on the Contributor Covenant v3.0. - SECURITY.md provides a clear policy for responsible vulnerability reporting. * docs: add codeowners and issue templates
1 parent 9112d40 commit 9ee14f2

5 files changed

Lines changed: 194 additions & 0 deletions

File tree

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Default owner for the entire repository
2+
* @aureliuscanon
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve Privlog
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Code snippet to scan: `...`
16+
2. Command you ran: `privlog ...`
17+
3. What you saw: `...`
18+
4. What you expected to see: `...`
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Environment (please complete the following information):**
24+
- OS: [e.g. macOS, Windows, Linux]
25+
- Python version: [e.g. 3.9]
26+
- Privlog version: [e.g. 0.2.1]
27+
28+
**Additional context**
29+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for Privlog
4+
title: "[FEAT] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. "I'm always frustrated when..."
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

CODE_OF_CONDUCT.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
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+
- Respecting the purpose of our community, our activities, and our ways of gathering.
16+
- Engaging kindly and honestly with others.
17+
- Respecting different viewpoints and experiences.
18+
- Taking responsibility for our actions and contributions.
19+
- Gracefully giving and accepting constructive feedback.
20+
- Committing to repairing harm when it occurs.
21+
- Behaving in other ways that promote and sustain the well-being of our community.
22+
23+
## Restricted Behaviors
24+
25+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
26+
27+
- Harassment. Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
28+
- Character attacks. Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
29+
- Stereotyping or discrimination. Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
30+
- Sexualization. Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
31+
- Violating confidentiality. Sharing or acting on someone’s personal or private information without their permission.
32+
- Endangerment. Causing, encouraging, or threatening violence or other harm toward any person or group.
33+
- Behaving in other ways that threaten the well-being of our community.
34+
35+
## Other Restrictions
36+
37+
- Misleading identity. Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
38+
- Failing to credit sources. Not properly crediting the sources of content you contribute.
39+
- Promotional materials. Sharing marketing or other commercial content in a way that is outside the norms of the community.
40+
- Irresponsible communication. Failing to responsibly present content which includes, links or describes any other restricted behaviors.
41+
42+
## Reporting an Issue
43+
44+
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.
45+
46+
When an incident does occur, it is important to report it promptly. To report a possible violation, please contact the repository maintainer directly or open a confidential GitHub issue.
47+
48+
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.
49+
50+
## Addressing and Repairing Harm
51+
52+
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.
53+
54+
### Warning
55+
56+
- **Event:** A violation involving a single incident or series of incidents.
57+
- **Consequence:** A private, written warning from the Community Moderators.
58+
- **Repair:** Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
59+
60+
### Temporarily Limited Activities
61+
62+
- **Event:** A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
63+
- **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.
64+
- **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.
65+
66+
### Temporary Suspension
67+
68+
- **Event:** A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
69+
- **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+
- **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+
72+
### Permanent Ban
73+
74+
- **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.
75+
- **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.
76+
- **Repair:** There is no possible repair in cases of this severity.
77+
78+
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.
79+
80+
## Scope
81+
82+
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.
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/.
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/
89+
90+
For answers to common questions about Contributor Covenant, see the FAQ at https://www.contributor-covenant.org/faq. Translations are provided at https://www.contributor-covenant.org/translations. Additional enforcement and community guideline resources can be found at https://www.contributor-covenant.org/resources. The enforcement ladder was inspired by the work of Mozilla’s code of conduct team.

SECURITY.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Privlog is currently in early development. Security fixes will generally be applied to the latest released version.
6+
7+
Users are encouraged to update to the most recent version available on PyPI.
8+
9+
## Reporting a Vulnerability
10+
11+
If you believe you have discovered a security vulnerability in Privlog, please report it responsibly.
12+
13+
Please **do not publicly disclose the issue immediately**.
14+
15+
Instead, report the issue through one of the following channels:
16+
17+
* Open a **GitHub Security Advisory** (preferred)
18+
* Contact the repository maintainer through GitHub
19+
20+
Include the following information if possible:
21+
22+
* A clear description of the issue
23+
* Steps to reproduce the behavior
24+
* Example code or logs demonstrating the issue
25+
* The version of Privlog affected
26+
* Any suggested mitigation or fix
27+
28+
## Scope of Security Reports
29+
30+
Security reports may include:
31+
32+
* Vulnerabilities in dependency handling
33+
* Packaging or distribution issues
34+
* Bugs that cause sensitive data detection to fail unexpectedly
35+
* Logic errors in rule evaluation that may cause false negatives
36+
* Supply-chain or build integrity concerns
37+
38+
Please note that Privlog is a **static analysis tool** designed to assist developers in identifying potentially sensitive logging patterns. It does not guarantee complete detection of all possible data leaks.
39+
40+
## Disclosure Process
41+
42+
After a report is received:
43+
44+
1. The issue will be reviewed and validated.
45+
2. A fix will be developed if the report is confirmed.
46+
3. A patch release will be issued when appropriate.
47+
4. Public disclosure may occur after a fix is available.
48+
49+
Responsible disclosure helps protect users and maintain the integrity of the project.
50+
51+
## Acknowledgements
52+
53+
We appreciate responsible security research and the efforts of contributors who help improve the safety and reliability of the project.

0 commit comments

Comments
 (0)