Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (46 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 1.32 KB

Contributing to fishmarks

Thanks for contributing.

Development setup

  1. Fork and clone the repository.
  2. Create a feature branch from master.
  3. Install Fish 3+.
  4. Install local hooks:
prek install

Validate changes locally

Run checks before committing:

fish tests/check.fish
fish tests/run.fish

Shortcut:

make test

Or run all hooks:

prek run --all-files

Record the README demo

Use asciinema to capture a cast and agg to render the GIF used by the README:

mkdir -p .github/assets

# Record a fresh cast
asciinema rec --idle-time-limit 1 --overwrite .github/assets/fishmarks-demo.cast

# Render to GIF
agg --font-family "Fira Code" --theme dracula \
  .github/assets/fishmarks-demo.cast .github/assets/fishmarks-demo.gif

Pull requests

  • Keep PRs focused and small when possible.
  • Include tests for behavior changes.
  • Update docs when usage or setup changes.
  • Use clear commit messages that explain why the change is needed.

Compatibility policy

  • The project targets Fish 3+.
  • Backward compatibility with existing bookmark storage (~/.sdirs) should be preserved unless a migration path is documented.

Versioning and changelog

  • Releases follow Semantic Versioning.
  • User-visible changes should be added to CHANGELOG.md under Unreleased.