Skip to content

chore: add CONTRIBUTING.md #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hyperfinitism merged 2 commits into from
Jan 20, 2026
Merged

chore: add CONTRIBUTING.md #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
474f21a
chore: add CONTRIBUTING.md
hyperfinitism Jan 20, 2026
25c488f
docs: add Contributing section with minor adjustment
hyperfinitism Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing

Contributions are welcome! Please follow these guidelines when contributing.

## Contribution Agreement

By contributing to this project, you agree that:

- You have the legal right to provide your contribution (or you have obtained permission from the rights holder).
- Your contribution may be used as part of this project and may be modified and redistributed as needed.
- Your contribution is provided under the terms of this project's license (see [LICENSE](/LICENSE)).

## Bug Reports / Feature Requests

- For bug reports and feature requests, please open an **Issue** first.
- If possible, include reproduction steps, expected behavior, actual behavior, and environment details (OS / Python version, etc.).

## Code Changes

If you would like to fix bugs or add features, please follow the steps below.

1. **Fork** this repository.
2. Create a working **branch** in your fork.
3. Make your changes and commit them on that branch.
4. Open a **Pull Request** to this repository.
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@

## Compatibility

### Python

- Python 3.12+

### SEV-SNP Revision

- SEV-SNP Firmware ABI Spec: Rev. 1.58 (May 2025)
Expand All @@ -20,12 +24,6 @@

## Getting Started

### Requirements

- Python 3.12+

### Install from Repository

```shell
pip install git+https://github.com/acompany-develop/py-snp-utils.git
```
Expand All @@ -50,3 +48,7 @@ The `examples/` directory contains scripts that serve as both usage examples and
| `display.py` | Display SNP attestation report in JSON format |
| `fetch.py` | Fetch ARK, ASK, VCEK and CRL from AMD KDS in PEM format |
| `verify.py` | Verify VCEK certificate chain and SNP report signature |

## Contributing

Contributions are welcome! Before contributing, please see [CONTRIBUTING.md](/CONTRIBUTING.md).