Streamline README quick start with bundled context sample#45
Merged
Merged
Conversation
API ChangessummaryBase version: v0.7.1 (latest) |
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the README quick start section by highlighting the bundled sf.Context fixture, making it easier for newcomers to start using Fixenv without writing custom helpers. The PR also adds comprehensive documentation pages and example tests demonstrating the prebuilt fixtures.
Key changes include:
- Streamlined README with better structure and clearer quick start examples featuring bundled fixtures
- New documentation structure with guides on getting started, scopes, cleanup, and advanced patterns
- Example tests demonstrating the
sfhelper fixtures (Context, TempDir, LocalTCPListener)
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Complete restructure with improved quick start, feature highlights, documentation links, and comparison table |
docs/getting-started.md |
New guide covering installation, first fixtures with both bundled and custom examples |
docs/scopes-and-lifetimes.md |
New guide explaining scope options and parameterised fixtures |
docs/cleanup-and-ordering.md |
New guide on cleanup callbacks and execution order |
docs/advanced-fixtures.md |
New guide covering fixture composition, custom environments, and observability |
docs/examples/README.md |
New walkthrough documentation for all example projects |
docs/README.md |
New documentation index linking to all guides |
examples/sf_helpers/context_fixture_test.go |
New test demonstrating sf.Context lifecycle |
examples/sf_helpers/tempdir_fixture_test.go |
New test demonstrating sf.TempDir cleanup |
examples/sf_helpers/tcp_listener_fixture_test.go |
New test demonstrating sf.LocalTCPListener scoping |
examples/custom_env_with_shared_content/custom_env_with_shared_content_test.go |
Removed file (appears to be consolidating examples) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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
Testing