Skip to content

Commit e2ad045

Browse files
author
DeepRat (ɢᴏɴᴢᴀʟᴏ ʀᴏᴍᴇʀᴏ)
authored
docs: prepare v0.1.0 public release
- Add professional README with badges and quickstart - Create interactive Jupyter notebook (00_quickstart.ipynb) - Add pytest-cov to CI workflow with coverage reporting - Create issue templates (bug, feature) and PR template - Add RELEASE_DRAFT.md with complete release notes - Configure Dependabot for dependency updates - Add security audit workflow with pip-audit - All changes maintain backward compatibility - Tests passing: 14 passed, 1 skipped, 41% coverage
1 parent 8bd7a82 commit e2ad045

File tree

9 files changed

+921
-77
lines changed

9 files changed

+921
-77
lines changed

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of the bug.
12+
13+
## Steps to Reproduce
14+
15+
1. Install trueeye version: `X.X.X`
16+
2. Run command or code: `...`
17+
3. Observe error or unexpected behavior
18+
19+
## Expected Behavior
20+
21+
What you expected to happen.
22+
23+
## Actual Behavior
24+
25+
What actually happened.
26+
27+
## Environment
28+
29+
- OS: [e.g., Ubuntu 22.04, Windows 11, macOS 13]
30+
- Python version: [e.g., 3.10.5]
31+
- TrueEye version: [e.g., 0.1.0]
32+
- Installation method: [pip, source]
33+
34+
## Additional Context
35+
36+
Any other relevant information, error messages, or screenshots.
37+
38+
```
39+
# Paste error messages or relevant output here
40+
```
41+
42+
## Minimal Reproducible Example
43+
44+
```python
45+
# Paste minimal code that reproduces the issue
46+
from trueeye import pipeline
47+
48+
# Your code here
49+
```

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
A clear and concise description of the feature you'd like to see.
12+
13+
## Use Case
14+
15+
Describe the problem this feature would solve or the workflow it would improve.
16+
17+
## Proposed Solution
18+
19+
How would you like this feature to work?
20+
21+
## Alternatives Considered
22+
23+
Have you considered any alternative solutions or workarounds?
24+
25+
## Additional Context
26+
27+
Any other context, examples, or references that might be helpful.
28+
29+
## Implementation Notes
30+
31+
If you have ideas about implementation, share them here (optional).

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
Brief description of the changes in this PR.
6+
7+
## Type of Change
8+
9+
- [ ] Bug fix (non-breaking change fixing an issue)
10+
- [ ] New feature (non-breaking change adding functionality)
11+
- [ ] Breaking change (fix or feature causing existing functionality to change)
12+
- [ ] Documentation update
13+
- [ ] Code refactoring
14+
- [ ] Performance improvement
15+
- [ ] Tests
16+
17+
## Checklist
18+
19+
- [ ] Tests pass locally (`pytest`)
20+
- [ ] Tests added/updated for new functionality
21+
- [ ] Documentation updated (README, docstrings, etc.)
22+
- [ ] Code follows project style guidelines
23+
- [ ] CI/CD pipeline passes (green checkmark)
24+
- [ ] No breaking changes (or documented if necessary)
25+
26+
## Testing
27+
28+
Describe how you tested these changes:
29+
30+
```bash
31+
# Commands used to test
32+
pytest
33+
trueeye caption --image test.png
34+
```
35+
36+
## Related Issues
37+
38+
Closes #(issue_number)
39+
40+
## Screenshots/Output
41+
42+
If applicable, add screenshots or command output showing the changes.
43+
44+
```
45+
# Paste relevant output here
46+
```
47+
48+
## Additional Notes
49+
50+
Any additional information reviewers should know.

.github/dependabot.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
version: 2
2+
updates:
3+
# GitHub Actions dependencies
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
open-pull-requests-limit: 5
10+
labels:
11+
- "dependencies"
12+
- "github-actions"
13+
14+
# Python dependencies
15+
- package-ecosystem: "pip"
16+
directory: "/"
17+
schedule:
18+
interval: "weekly"
19+
day: "monday"
20+
open-pull-requests-limit: 5
21+
labels:
22+
- "dependencies"
23+
- "python"
24+
ignore:
25+
# Ignore major version updates for stability
26+
- dependency-name: "*"
27+
update-types: ["version-update:semver-major"]

.github/workflows/security.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Security Audit
2+
3+
on:
4+
schedule:
5+
# Run every Monday at 9:00 AM UTC
6+
- cron: '0 9 * * 1'
7+
workflow_dispatch: # Allow manual trigger
8+
pull_request:
9+
paths:
10+
- 'pyproject.toml'
11+
- 'requirements*.txt'
12+
13+
jobs:
14+
security-audit:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Set up Python
21+
uses: actions/setup-python@v5
22+
with:
23+
python-version: '3.11'
24+
25+
- name: Install dependencies
26+
run: |
27+
python -m pip install --upgrade pip
28+
pip install -e .
29+
pip install pip-audit
30+
31+
- name: Run pip-audit
32+
run: |
33+
pip-audit --desc --skip-editable
34+
continue-on-error: true
35+
36+
- name: Security summary
37+
run: |
38+
echo "Security audit completed"
39+
echo "Check the output above for any vulnerabilities"

.github/workflows/tests.yml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,18 @@ jobs:
2626
python -m pip install --upgrade pip
2727
pip install -e .
2828
29-
- name: Install pytest
29+
- name: Install test dependencies
3030
run: |
31-
pip install pytest
31+
pip install pytest pytest-cov
3232
33-
- name: Run tests
33+
- name: Run tests with coverage
3434
run: |
35-
pytest
35+
pytest --cov=trueeye --cov-report=term-missing --cov-report=xml
36+
37+
- name: Upload coverage reports
38+
uses: codecov/codecov-action@v4
39+
if: always()
40+
with:
41+
token: ${{ secrets.CODECOV_TOKEN }}
42+
files: ./coverage.xml
43+
fail_ci_if_error: false

0 commit comments

Comments
 (0)