- AGE encryption with master password model - Core commands: init, show, insert, edit, generate, rm, mv, cp, find, grep, ls - Git integration for version control - Clipboard support (X11 and Wayland) - Secure password generation - Backup and restore functionality - Comprehensive security features - Complete documentation
1.5 KiB
1.5 KiB
Contributing to PassAGE
Thank you for your interest in contributing to PassAGE!
Getting Started
- Fork the repository on GitHub
- Clone your fork locally
- Create a branch for your changes
- Make your changes and test them
- Submit a pull request
Development Setup
-
Fork and clone the repository:
git clone https://git.fraggle.lol/fraggle/PassAGE.git cd PassAGE -
Install dependencies:
go mod download -
Build the project:
make build # or go build -o passage . -
Run tests:
make test # or go test ./...
Code Style
- Follow standard Go formatting (
go fmt) - Run
go vetbefore committing - Use meaningful variable and function names
- Add comments for non-obvious code
Testing
- Write tests for new features
- Ensure all tests pass:
go test ./... - Test with race detector:
make test-race
Submitting Changes
- Create a branch for your changes
- Make your changes
- Ensure code compiles and tests pass
- Submit a pull request with a clear description
Building Manpages
If you modify documentation, rebuild the manpage:
make man
Requires pandoc or go-md2man to be installed.
Repository Setup
If you're setting up the repository for the first time, see SETUP.md for git initialization instructions.
Questions?
Feel free to open an issue for questions or discussions.