Skip to content

Commit fc9281d

Browse files
esteiningeresteininger
committed
chore: repo hygiene (license, conduct, contributing, security, changelog, editorconfig, gitattributes, issue/PR templates, CI & release workflows, metadata, badges)
1 parent 28d5c6c commit fc9281d

File tree

17 files changed

+440
-0
lines changed

17 files changed

+440
-0
lines changed

‎.editorconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
indent_style = space
8+
indent_size = 2
9+
trim_trailing_whitespace = true
10+
11+
[*.py]
12+
indent_size = 4
13+

‎.gitattributes‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
* text=auto eol=lf
2+
*.png binary
3+

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. ...
13+
2. ...
14+
15+
**Expected behavior**
16+
What you expected to happen.
17+
18+
**Screenshots/logs**
19+
If applicable, add screenshots or logs.
20+
21+
**Environment**
22+
- OS:
23+
- Python:
24+
- Package version:
25+
26+
**Additional context**
27+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description.
9+
10+
**Describe the solution you'd like**
11+
What should happen.
12+
13+
**Describe alternatives you've considered**
14+
Any alternatives you considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots.

‎.github/pull_request_template.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Summary
2+
3+
Describe the change and why it’s needed.
4+
5+
## Changes
6+
-
7+
8+
## Testing
9+
- [ ] Unit tests passed
10+
- [ ] Manual validation
11+
12+
## Checklist
13+
- [ ] Docs updated (README/CHANGELOG)
14+
- [ ] Types/lint ok
15+
- [ ] Backwards compatible

‎.github/workflows/ci.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Set up Python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: '3.11'
18+
- name: Install deps
19+
run: |
20+
python -m pip install --upgrade pip
21+
pip install -e .[emb]
22+
pip install pytest
23+
- name: Run tests
24+
run: pytest -q
25+

‎.github/workflows/release.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Publish to PyPI
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
build-and-publish:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-python@v5
13+
with:
14+
python-version: '3.11'
15+
- name: Install build tools
16+
run: |
17+
python -m pip install --upgrade pip
18+
pip install build twine
19+
- name: Build
20+
run: python -m build
21+
- name: Publish
22+
env:
23+
TWINE_USERNAME: __token__
24+
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
25+
run: twine upload dist/*
26+

‎CHANGELOG.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented here.
4+
5+
## [0.3.0] - 2025-09-09
6+
- Vectors catalogs and output wiring
7+
- Configurable cattax flag
8+
- Overrides support
9+
- Unmapped report and richer outputs
10+
- Tests for new features; README and Python API docs
11+
- PyPI packaging and metadata
12+

‎CODE_OF_CONDUCT.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Contributor Covenant Code of Conduct
2+
3+
This project follows the Contributor Covenant. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to security@mixpeek.com.
4+
5+
See `https://www.contributor-covenant.org/version/2/1/code_of_conduct/` for the full text.
6+

‎CONTRIBUTING.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Contributing
2+
3+
1. Fork and create a feature branch.
4+
2. Setup dev env: `python -m venv .venv && source .venv/bin/activate && pip install -e .[emb] && pip install -r requirements-dev.txt || pip install pytest`
5+
3. Run tests: `pytest -q`
6+
4. Open a PR with a concise description and screenshots/logs if helpful.
7+
8+
### Commit style
9+
Use conventional commits where possible: `feat:`, `fix:`, `docs:`, `chore:`, `test:`, `refactor:`.
10+
11+
### Reporting issues
12+
Please include reproduction steps, expected vs actual behavior, and environment details.
13+

0 commit comments

Comments
 (0)