fraggle 388c14426c Update README for accurate cross-platform support

- Clarify clipboard support is Linux-only (X11/Wayland)
- Remove unnecessary documentation files (SETUP.md, CODE_STRUCTURE.md, CHANGELOG.md)
- Update installation prerequisites

2026-01-11 18:57:11 -04:00

1.3 KiB

Raw Blame History

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 vet before 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.

Questions?

Feel free to open an issue for questions or discussions.

1.3 KiB Raw Blame History