diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b9dbfda --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index fa80e7a..91f2971 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,10 @@ ## Compatibility +### Python + +- Python 3.12+ + ### SEV-SNP Revision - SEV-SNP Firmware ABI Spec: Rev. 1.58 (May 2025) @@ -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 ``` @@ -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).