Skip to content

Commit b15f8be

Browse files
committed
docs: add repository governance files and README links
1 parent 1fe64d0 commit b15f8be

5 files changed

Lines changed: 178 additions & 0 deletions

File tree

‎AUTHORS.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Authors
2+
3+
## Maintainers
4+
5+
- Hugo Payet ([@SizzleUnrlsd](https://github.com/SizzleUnrlsd))
6+
7+
Other contributors are credited in this repository's Git history and pull requests.

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing to CoreTrace Python Analyzer
2+
3+
## Local setup
4+
5+
Python 3.11 or newer is required. Create a virtual environment and install the development dependencies:
6+
7+
```bash
8+
python3 -m venv .venv
9+
.venv/bin/python -m pip install -e '.[dev]'
10+
.venv/bin/python -m mypy
11+
.venv/bin/python -m pytest
12+
.venv/bin/python -m ruff check .
13+
```
14+
15+
The [README](README.md#development) explains the separate network-dependent regression corpus. Update documentation when changing rules, reports or plugin contracts, and describe the checks you ran in your pull request. Keep changes focused and use an English Conventional Commit subject.
16+
17+
Report suspected vulnerabilities through [SECURITY.md](SECURITY.md) rather than a public issue.

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ semantic resolution of imports and scopes, lowering to a small intermediate
2323
representation (PyIR), control-flow graphs, SSA, data-flow and abstract interpretation,
2424
interprocedural summaries, taint and refutation, then plugins and reporters.
2525

26+
## Repository documents
27+
28+
- [CONTRIBUTING.md](CONTRIBUTING.md)
29+
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
30+
- [AUTHORS.md](AUTHORS.md)
31+
- [CHANGELOG.md](CHANGELOG.md)
32+
- [LICENSE](LICENSE)
33+
- [SECURITY.md](SECURITY.md)
34+
2635
## Development
2736

2837
```bash

‎SECURITY.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
## Supported versions
4+
5+
Security fixes target `main` and the latest tagged release, when one exists. Older tags are not maintained. Include the exact tag or commit in a report.
6+
7+
## Reporting a vulnerability
8+
9+
Report privately through [GitHub private vulnerability reporting](https://github.com/CoreTrace/coretrace-python-analyzer/security/advisories/new). Do not publish a suspected vulnerability in an issue or pull request.
10+
11+
Include reproduction steps, expected and observed behavior, the affected platform and version, and the possible impact. Remove credentials and other sensitive data from examples.
12+
13+
## Scope
14+
15+
CoreTrace Python Analyzer parses and analyzes source trees and dependency metadata. Reports about crafted input, unsafe file access or report generation should include a sanitized sample and the command used.

0 commit comments

Comments
 (0)