Skip to content

Commit a723f96

Browse files
author
Ramprasad Gaddam
committed
docs: Add OpenSSF badge requirements
- Add CHANGELOG.md following Keep a Changelog format - Add issue templates (bug report, feature request) - Add PR template with checklist - Add Dependabot for automated security updates Closes #6, #7, #8, #9 Signed-off-by: Ramprasad Gaddam <[email protected]>
1 parent 40ea0cd commit a723f96

File tree

6 files changed

+294
-0
lines changed

6 files changed

+294
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Bug Report
2+
description: Report a bug in Vouch Protocol
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear description of what the bug is.
16+
placeholder: Describe the bug...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduce
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior.
25+
placeholder: |
26+
1. Create a Signer with...
27+
2. Call sign() with...
28+
3. See error...
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What you expected to happen.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: actual
42+
attributes:
43+
label: Actual Behavior
44+
description: What actually happened.
45+
validations:
46+
required: true
47+
48+
- type: dropdown
49+
id: version
50+
attributes:
51+
label: Vouch Version
52+
options:
53+
- "1.3.1"
54+
- "1.3.0"
55+
- "1.2.0"
56+
- "1.1.x or earlier"
57+
validations:
58+
required: true
59+
60+
- type: dropdown
61+
id: python
62+
attributes:
63+
label: Python Version
64+
options:
65+
- "3.13"
66+
- "3.12"
67+
- "3.11"
68+
- "3.10"
69+
- "3.9"
70+
71+
- type: textarea
72+
id: context
73+
attributes:
74+
label: Additional Context
75+
description: Any other context about the problem.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security Vulnerability
4+
url: https://github.com/vouch-protocol/vouch/security/advisories/new
5+
about: Report security vulnerabilities through GitHub Security Advisories
6+
- name: Discussion
7+
url: https://github.com/vouch-protocol/vouch/discussions
8+
about: Ask questions and discuss ideas

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Feature Request
2+
description: Suggest a new feature for Vouch Protocol
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please fill out the form below.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: What problem does this feature solve?
16+
placeholder: I'm always frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: alternatives
30+
attributes:
31+
label: Alternatives Considered
32+
description: Other solutions or features you've considered.
33+
34+
- type: dropdown
35+
id: component
36+
attributes:
37+
label: Component
38+
description: Which component would this affect?
39+
options:
40+
- Signer
41+
- Verifier
42+
- Delegation Chains
43+
- Key Management
44+
- Integrations
45+
- Documentation
46+
- Other
47+
48+
- type: textarea
49+
id: context
50+
attributes:
51+
label: Additional Context
52+
description: Any other context or screenshots.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Description
2+
3+
<!-- Brief description of the changes in this PR -->
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix (non-breaking change that fixes an issue)
8+
- [ ] New feature (non-breaking change that adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
10+
- [ ] Documentation update
11+
- [ ] Refactoring (no functional changes)
12+
13+
## Related Issues
14+
15+
<!-- Link any related issues here -->
16+
Closes #
17+
18+
## Changes Made
19+
20+
<!-- List the main changes -->
21+
-
22+
-
23+
24+
## Testing
25+
26+
<!-- Describe how you tested these changes -->
27+
- [ ] Existing tests pass (`pytest tests/`)
28+
- [ ] New tests added for new functionality
29+
- [ ] Manual testing performed
30+
31+
## Checklist
32+
33+
- [ ] My code follows the project's code style
34+
- [ ] I have added/updated documentation as needed
35+
- [ ] I have added tests for new functionality
36+
- [ ] All tests pass locally
37+
- [ ] My commits are signed off (DCO)
38+
39+
## Screenshots (if applicable)
40+
41+
<!-- Add screenshots for UI changes -->

‎.github/dependabot.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
version: 2
2+
updates:
3+
# Python dependencies
4+
- package-ecosystem: "pip"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
open-pull-requests-limit: 5
10+
labels:
11+
- "dependencies"
12+
- "python"
13+
commit-message:
14+
prefix: "deps"
15+
groups:
16+
dev-dependencies:
17+
patterns:
18+
- "pytest*"
19+
- "black"
20+
- "mypy"
21+
- "ruff"
22+
23+
# GitHub Actions
24+
- package-ecosystem: "github-actions"
25+
directory: "/"
26+
schedule:
27+
interval: "weekly"
28+
day: "monday"
29+
open-pull-requests-limit: 3
30+
labels:
31+
- "dependencies"
32+
- "github-actions"
33+
commit-message:
34+
prefix: "ci"

‎CHANGELOG.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Changelog
2+
3+
All notable changes to Vouch Protocol will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
- Chain of Custody (delegation chains) for multi-agent systems
12+
- W3C specification draft
13+
14+
### Fixed
15+
- Resolved jwcrypto deprecation warnings
16+
17+
## [1.3.1] - 2025-12-31
18+
19+
### Added
20+
- `reputation_score` parameter to `Signer.sign()`
21+
- Reputation field in `Passport` dataclass
22+
- Prior art disclosure system (PAD-001, PAD-002, PAD-003)
23+
24+
### Changed
25+
- Updated documentation with visual diagrams
26+
27+
## [1.3.0] - 2025-12-28
28+
29+
### Added
30+
- Apache 2.0 as default license
31+
- Comprehensive README with use cases
32+
33+
### Changed
34+
- Major README overhaul
35+
36+
## [1.2.0] - 2025-12-15
37+
38+
### Added
39+
- Key revocation registry
40+
- Reputation engine with event tracking
41+
- Cloud KMS providers (AWS, GCP, Azure)
42+
- TypeScript SDK (separate package)
43+
- Redis-backed stores for all components
44+
- Kafka integration for reputation events
45+
46+
### Changed
47+
- License structure redesign
48+
49+
## [1.1.3] - 2025-12-10
50+
51+
### Added
52+
- Comprehensive test suite (76 tests)
53+
- AsyncVerifier for concurrent verification
54+
- Caching layer (Memory, Redis, Tiered)
55+
- Rate limiting with Redis support
56+
- Nonce tracking for replay protection
57+
58+
## [1.1.0] - 2025-12-01
59+
60+
### Added
61+
- Audio signing for real-time voice
62+
- Key rotation with RotatingKeyProvider
63+
- Agent registry for key discovery
64+
- Metrics collection with Prometheus format
65+
66+
### Changed
67+
- Improved verifier performance
68+
69+
## [1.0.0] - 2025-11-15
70+
71+
### Added
72+
- Initial release
73+
- Signer with Ed25519 keys
74+
- Verifier with DID resolution
75+
- JWS token format
76+
- Basic documentation
77+
78+
[Unreleased]: https://github.com/vouch-protocol/vouch/compare/v1.3.1...HEAD
79+
[1.3.1]: https://github.com/vouch-protocol/vouch/compare/v1.3.0...v1.3.1
80+
[1.3.0]: https://github.com/vouch-protocol/vouch/compare/v1.2.0...v1.3.0
81+
[1.2.0]: https://github.com/vouch-protocol/vouch/compare/v1.1.3...v1.2.0
82+
[1.1.3]: https://github.com/vouch-protocol/vouch/compare/v1.1.0...v1.1.3
83+
[1.1.0]: https://github.com/vouch-protocol/vouch/compare/v1.0.0...v1.1.0
84+
[1.0.0]: https://github.com/vouch-protocol/vouch/releases/tag/v1.0.0

0 commit comments

Comments
 (0)