PassAGE/CONTRIBUTING.md
fraggle 4242415af9 Remove repository URLs and fix CI comments
- Remove all repository URLs from README (users are already in repo)
- Clarify CI uses Ubuntu for testing only, not Ubuntu-specific
- Remove duplicate clipboard prerequisite line
- Use placeholder <repository-url> in install docs
2026-01-11 19:00:53 -04:00

1.3 KiB

Contributing to PassAGE

Thank you for your interest in contributing to PassAGE!

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a branch for your changes
  4. Make your changes and test them
  5. Submit a pull request

Development Setup

  1. Fork and clone the repository:

    git clone <repository-url>
    cd PassAGE
    
  2. Install dependencies:

    go mod download
    
  3. Build the project:

    make build
    # or
    go build -o passage .
    
  4. 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

  1. Create a branch for your changes
  2. Make your changes
  3. Ensure code compiles and tests pass
  4. 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.