46 lines (35 loc) · 1.09 KB

Contributing to spass-tools

Thanks for your interest in contributing! Here's how to get started.

Getting Started

Fork the repository

Clone your fork:

git clone https://github.com/your-username/spass-tools.git
cd spass-tools

Create a virtual environment and install dependencies:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Create a branch for your change:
```
git checkout -b my-feature
```

Making Changes

Keep changes focused — one feature or fix per PR
Follow the existing code style
Test your changes with both encrypt and decrypt flows
Update documentation if your change affects usage

Submitting a Pull Request

Push your branch to your fork
Open a PR against main
Describe what your change does and why

Reporting Bugs

Open an issue with:

Steps to reproduce
Expected vs actual behavior
Python version and OS

Security Issues

See SECURITY.md for reporting vulnerabilities.