v0.0.2: local testing examples, docs and steering fixes - #3
Merged
Merged
Conversation
The steering docs described a nested password_forge/ root left over from a deleted older project. Point structure.md at the real password-forge-ruby-gem/ root (adding examples/, docs/, bin/) and fix the 'run from' path in tech.md.
Add examples/smoke_test.rb (loads the gem from source and prints samples) and examples/local-consumer/ (a minimal external project depending on the gem via path:). Ignore the consumer's generated lockfile and .bundle/.
Add docs/local-testing.md (run from this repo, use from another project via a path dependency, build/install a .gem, uninstall/switch to the published gem) and docs/README.md as the documentation index.
These folders are for local development and documentation only and should not ship in the published gem.
Add a 'Trying it locally' section linking to docs/ and examples/. Clarify that the gem is not on RubyGems yet, soften the Kiro-features wording to reflect the roadmap, and add the 0.0.2 entry.
Add local-testing examples and docs; exclude them from the package; record the steering-docs tree fix.
- Add graphify-out/ directory to gitignore (build output from graphify) - Add .graphify-cache/ directory to gitignore (cache files) - Add hermes-run.sh script to gitignore (local execution script) - Keeps repository clean by excluding generated and temporary files from version control
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Bumps the gem to v0.0.2 and adds a local-testing story around the generator, without touching the runtime code.
Changes
examples/):smoke_test.rbloads the gem from source and prints sample passwords;local-consumer/is a minimal external project depending on the gem via apath:reference.docs/): documentation index (docs/README.md) and a local-testing guide (docs/local-testing.md).examples/anddocs/excluded from the built gem..kiro/steering/structure.mdandtech.md(stale nestedpassword_forge/root removed).0.0.2following Keep a Changelog / SemVer.Testing
bundle exec rake(RSpec + RuboCop) — run locally.Notes
Documentation and tooling only; no changes to the public API or generator behaviour.