Repository navigation
docs: README for pub.dev, community files, self-contained example - #11
Merged
Merged
Conversation
… example - README: badges, installation from pub.dev, quick start, examples table, platform matrix (CI-tested vs. mapped-only targets), contributing and support sections; detailed guides moved to doc/master.md, doc/outstation.md, doc/architecture.md and doc/benchmarks.md - example/example.dart: outstation + master in one process (pub.dev Example tab), example/README.md - CONTRIBUTING.md (setup, checks, ABI sync rules, generators, releases), CODE_OF_CONDUCT.md (Contributor Covenant 2.1), SECURITY.md - issue forms (bug, feature), issue template config, PR template - CHANGELOG: Unreleased section, policy note, breaking changes marked Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AVXyRT6zJUzzD6oSDcfG9W
pub.dev scored 0.3.0 at 150/160: no example (added in the previous commit) and undocumented accessors inherited from the private block base classes. Also declare the 110 column page width in analysis_options so pana's format check matches the repository style. Local pana: 160/160. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AVXyRT6zJUzzD6oSDcfG9W
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.
What and why
Prepares the project for outside contributors and lifts the pub.dev score of the next release (0.3.0 scored 150/160: no example, undocumented inherited accessors).
dart pub add dnp3, quick start, examples table, platform matrix (CI-tested vs. mapped-only targets), contributing / support / security sections. Detailed guides moved todoc/master.md,doc/outstation.md,doc/architecture.md,doc/benchmarks.md.example/example.dart: outstation + master in one process (read, zero-copy decode, CROB), runs to completion;example/README.md.CONTRIBUTING.md(setup, CI checks, Dart ↔ Rust ABI rules, generators, crate upgrades, release steps),CODE_OF_CONDUCT.md(Contributor Covenant 2.1),SECURITY.md(private advisories), issue forms (bug / feature), issue config, PR template.## Unreleasedsection and versioning note; breaking changes in 0.2.0 / 0.3.0 marked.analysis_options.yamlsetsformatter: page_width: 110sodart formatand pub.dev's format check agree.How was it tested?
outstation.dart+master.dart(commands, attributes, values),worker_isolate.dart,example.dart.dart analyze --fatal-infosclean; 66 Dart tests pass.dart pub publish --dry-run: 0 warnings. Localpana: 160/160.Checklist
dart analyze --fatal-infosanddart format -l 110are cleandart testpasses; new behavior is covered by a test (no behavior change)native/change)CHANGELOG.mdhas an entry under## UnreleasedNote for the maintainer:
ci.yml's format step lists the example files explicitly, soexample/example.dartis not format-checked in CI until it is added there (workflow files cannot be changed from this session). Private vulnerability reporting must be enabled in Settings → Code security forSECURITY.mdto work.🤖 Generated with Claude Code
https://claude.ai/code/session_01AVXyRT6zJUzzD6oSDcfG9W
Generated by Claude Code