- 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
1.3 KiB
1.3 KiB
Contributing to PassAGE
Thank you for your interest in contributing to PassAGE!
Getting Started
- Fork the repository
- 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 <repository-url> 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.
Questions?
Feel free to open an issue for questions or discussions.