Christopher Allen Lane
ecfb83a3b0
docs: clean up project documentation
...
- Convert all headings from underline style to ATX style
- Fix heading hierarchy in INSTALLING.md (H3→H2, H4→H3)
- Move Installing section before Usage in README
- Bump install snippet version from 4.5.1 to 4.7.0
- Add feature request guidance to CONTRIBUTING.md
- Add installer package and .cheat discovery to CLAUDE.md
- Remove unused reference links and dead HTML comments
- Trim trailing whitespace
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com >
2026-02-15 12:56:58 -05:00
Christopher Allen Lane
cc85a4bdb1
chore: bump version to 4.5.0
...
Bug fixes:
- Fix inverted pager detection logic (returned error instead of path)
- Fix repo.Clone ignoring destination directory parameter
- Fix sheet loading using append on pre-sized slices
- Clean up partial files on copy failure
- Trim whitespace from editor config
Security:
- Add path traversal protection for cheatsheet names
Performance:
- Move regex compilation outside search loop
- Replace string concatenation with strings.Join in search
Build:
- Remove go:generate; embed config and usage as string literals
- Parallelize release builds
- Add fuzz testing infrastructure
Testing:
- Improve test coverage from 38.9% to 50.2%
- Add fuzz tests for search, filter, tags, and validation
Documentation:
- Fix inaccurate code examples in HACKING.md
- Add missing --conf and --all options to man page
- Add ADRs for path traversal, env parsing, and search parallelization
- Update CONTRIBUTING.md to reflect project policy
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com >
2026-02-14 19:56:19 -05:00
Christopher Allen Lane
7fed1f63a6
docs: create HACKING.md
...
Create a `HACKING.md` file for onboarding new developers to `cheat`.
2022-07-05 15:07:34 -04:00
Christopher Allen Lane
f17de401e5
docs(CONTRIBUTING): pr against develop
...
Add a note to `CONTRIBUTING.md` requesting that contributors open
pull-requests against the `develop` branch.
2021-10-09 09:34:23 -04:00
Chris Lane
36960fc164
chore: adds license and contributing file
2019-10-26 16:13:46 -04:00
Chris Lane
e5114a3e76
Re-wrote from scratch in Golang
...
- Re-implemented the project in Golang, and deprecated Python entirely
- Implemented several new, long-requested features
- Refactored cheatsheets into a separate repository
2019-10-20 10:02:28 -04:00
Chris Lane
fb5ec798fa
CONTRIBUTING.md
...
Made minor additions to the `CONTRIBUTING.md` file.
2017-09-05 13:48:06 -04:00
Chris Lane
b9241efab1
CONTRIBUTING.md
...
Put some useful information in `CONTRIBUTING.md`.
2017-02-28 17:45:53 -05:00
Chris Lane
c1d4c768de
CONTRIBUTING.md
...
- Added a paragraph on licensing
- Trivial edits
2016-02-17 14:12:58 -05:00
Chris Lane
8677e0c35a
Added a CONTRIBUTING.md file
...
- Added a CONTRIBUTING.md file
- Corrected a small indentation error
- version bump
2014-05-25 22:19:43 -04:00
