Skip to content

Commit 9fe3710

Browse files
Fatal1tyFatal1ty
committed
Add .github folder
1 parent fb64c4e commit 9fe3710

6 files changed

Lines changed: 302 additions & 0 deletions

File tree

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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, socioeconomic 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 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
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of 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
35+
address, 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 at
63+
random.gauss@gmail.com.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
* maybe-missing version:
11+
* Python version:
12+
* Operating System:
13+
14+
### Description
15+
16+
Describe what you were trying to get done.
17+
Tell us what happened, what went wrong, and what you expected to happen.
18+
19+
### What I Did
20+
21+
```
22+
Paste the code, command(s) you ran and the output.
23+
If there was a crash, please include the traceback here.
24+
```

‎.github/ISSUE_TEMPLATE/feature_request.md‎

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 this project
4+
title: ''
5+
labels: ''
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 about the feature request here.

‎.github/SECURITY.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
At our GitHub project, we take security seriously and strive to maintain
2+
the highest level of security for our users. We encourage all members of our
3+
community to report any security-related bugs they discover to us as soon as
4+
possible. In order to ensure that these reports are handled in a secure and
5+
efficient manner, we have established the following policy:
6+
7+
1. Reporting Security-Related Bugs: If you believe that you have discovered
8+
a security-related bug in our project, please report it to us immediately
9+
by sending an email to random.gauss@gmail.com. Please do not open
10+
a GitHub issue for security-related bugs, as this may put our users at risk.
11+
12+
2. Providing Details: When reporting a security-related bug, please provide
13+
as much detail as possible, including a detailed description of the issue,
14+
steps to reproduce the problem, and any relevant code or screenshots.
15+
This will help us to quickly identify and address the issue.
16+
17+
3. Confidentiality: We take the confidentiality of security-related bug reports
18+
very seriously. We will keep all information related to the bug confidential
19+
and will not share it with anyone outside of our team without your
20+
permission, except as required by law.
21+
22+
4. Resolution: We will work diligently to resolve the issue as quickly as
23+
possible and will keep you informed of our progress throughout the process.
24+
25+
5. Public Disclosure: Once the issue has been resolved, we will make a release
26+
and announce the security fix through our normal communication channels.
27+
When it makes sense we may also obtain a CVE ID.

‎.github/workflows/main.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: tests
2+
3+
on:
4+
push:
5+
branches:
6+
- '*'
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
test-code-style:
13+
name: Code style tests
14+
runs-on: ubuntu-latest
15+
strategy:
16+
fail-fast: false
17+
matrix:
18+
python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
19+
steps:
20+
- uses: actions/checkout@v6
21+
- name: Set up Python ${{ matrix.python-version }}
22+
uses: actions/setup-python@v6
23+
with:
24+
python-version: ${{ matrix.python-version }}
25+
allow-prereleases: true
26+
- name: Install dependencies
27+
run: |
28+
python -m venv .venv
29+
source .venv/bin/activate
30+
pip install mypy pyright
31+
pip install .
32+
- name: Run mypy
33+
run: |
34+
source .venv/bin/activate
35+
mypy maybe_missing
36+
- name: Run pyright
37+
run: |
38+
source .venv/bin/activate
39+
pyright maybe_missing
40+
41+
test-posix:
42+
name: Tests on Posix
43+
needs:
44+
- test-code-style
45+
runs-on: ubuntu-latest
46+
strategy:
47+
fail-fast: false
48+
matrix:
49+
python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
50+
steps:
51+
- uses: actions/checkout@v6
52+
- name: Set up Python ${{ matrix.python-version }}
53+
uses: actions/setup-python@v6
54+
with:
55+
python-version: ${{ matrix.python-version }}
56+
allow-prereleases: true
57+
- name: Install dependencies
58+
run: |
59+
python -m venv .venv
60+
source .venv/bin/activate
61+
pip install .
62+
- name: Run tests
63+
run: |
64+
source .venv/bin/activate
65+
python -m unittest discover -s tests -p "test_*.py" -v

‎.github/workflows/publish.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: publish.yml
2+
on:
3+
release:
4+
types:
5+
- published
6+
7+
jobs:
8+
pypi-publish:
9+
name: Upload release to PyPI
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: read
13+
id-token: write
14+
environment:
15+
name: pypi
16+
url: https://pypi.org/project/maybe-missing/
17+
18+
steps:
19+
- name: Checkout code
20+
uses: actions/checkout@v6
21+
22+
- name: Set up Python 3.14
23+
uses: actions/setup-python@v6
24+
with:
25+
python-version: "3.14"
26+
27+
- name: Install Poetry
28+
run: |
29+
curl -sSL https://install.python-poetry.org | python - -y
30+
31+
- name: Install dependencies
32+
run: poetry install --no-interaction --no-root
33+
34+
- name: Build
35+
run: poetry build
36+
37+
- name: Publish to PyPI
38+
uses: pypa/gh-action-pypi-publish@release/v1

0 commit comments

Comments
 (0)