Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug report
description: Something does not work as documented
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for reporting! Security problems must not be reported here: see SECURITY.md.
If the problem is in the DNP3 protocol behavior of the Rust stack itself, please also
check https://github.com/stepfunc/dnp3.
- type: textarea
id: what
attributes:
label: What happened?
description: What you did, what you expected and what happened instead.
validations:
required: true
- type: textarea
id: repro
attributes:
label: Minimal reproduction
description: |
A small program that shows the problem, ideally an outstation and a master in one
file like example/example.dart.
render: dart
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs and errors
description: |
Exceptions with their `detail`, and native logs if relevant
(`Dnp3.enableLogging(level: Dnp3LogLevel.debug)` and a `DecodeLevel` on the channel).
render: text
- type: input
id: version
attributes:
label: Package version
placeholder: "0.3.0"
validations:
required: true
- type: dropdown
id: platform
attributes:
label: Platform
multiple: true
options: [Android, iOS, macOS, Linux, Windows]
validations:
required: true
- type: textarea
id: env
attributes:
label: Environment
description: Output of `dart --version` or `flutter --version`, Rust version (`rustc -V`), device / OS version, peer DNP3 device if any.
render: text
- type: dropdown
id: native
attributes:
label: How is the native library obtained?
options:
- Built by the build hook (Rust toolchain)
- Prebuilt libraries (DNP3_PREBUILT_DIR / prebuilt_dir)
- Not sure
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Security vulnerability
url: https://github.com/gencto/dnp3_plugin/security/advisories/new
about: Please report security problems privately.
- name: DNP3 protocol stack (upstream)
url: https://github.com/stepfunc/dnp3/issues
about: Protocol behavior of the underlying Rust library.
- name: Documentation and API reference
url: https://pub.dev/documentation/dnp3/latest/
about: Every public member of the package is documented.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Feature request
description: Suggest an improvement or a missing part of the DNP3 API
labels: [enhancement]
body:
- type: textarea
id: problem
attributes:
label: What problem would this solve?
description: The use case, e.g. the device or system you are integrating with.
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed API or behavior
description: How you would like to use it. A Dart snippet helps.
render: dart
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
- type: checkboxes
id: contribute
attributes:
label: Contribution
options:
- label: I would like to implement this (see CONTRIBUTING.md)
16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## What and why

<!-- What does this change and why is it needed? Link the issue it fixes (e.g. "Fixes #123"). -->

## How was it tested?

<!-- New or changed tests, platforms you ran it on, devices you talked to. -->

## Checklist

- [ ] `dart analyze --fatal-infos` and `dart format -l 110` are clean
- [ ] `dart test` passes; new behavior is covered by a test
- [ ] Rust: `cargo fmt --check`, `cargo clippy --all-targets -- -D warnings`, `cargo test` (if `native/` changed)
- [ ] New public API has dartdoc comments
- [ ] `CHANGELOG.md` has an entry under `## Unreleased` (if users notice the change)
- [ ] Dart ↔ Rust interface changes: bindings, `protocol.dart` / `core.rs`, `doc/wire_format.md` and the ABI version updated (see CONTRIBUTING.md)
21 changes: 19 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# Changelog

All notable changes to this package are documented here. Versions follow
[semantic versioning](https://semver.org/); while the version is `0.x`, a minor version may
contain breaking changes, which are marked **Breaking**. New entries go under
`## Unreleased` (see [CONTRIBUTING.md](CONTRIBUTING.md)).

## Unreleased

* Docs: README restructured for pub.dev (installation from pub.dev, platform support matrix,
examples table); the detailed guides moved to `doc/master.md`, `doc/outstation.md`,
`doc/architecture.md` and `doc/benchmarks.md`.
* New `example/example.dart`: a self-contained outstation + master demo.
* Documented the flyweight accessors (`valueAt`, `flagsAt`, `timeAt`, ...) inherited by the
measurement blocks; `analysis_options.yaml` sets the formatter page width to 110 so
`dart format` and pub.dev's analysis agree.
* Community files: `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `SECURITY.md`, issue and pull
request templates.

## 0.3.0

* `MasterServer` releases the channel of an accepted connection when its session ends and
Expand All @@ -17,7 +34,7 @@
* `Dnp3.closeIsolate` / `Dnp3.shutdown` close the event streams of the isolate's objects;
later calls fail with `ShutdownException`.
* `MeasurementWorker` acknowledges a fragment even if the handler throws.
* Internal helpers (`decodeResults`, `decodeAssociationMessage`, `decodeAttribute`,
* **Breaking:** internal helpers (`decodeResults`, `decodeAssociationMessage`, `decodeAttribute`,
`encodeAttribute`, the `ClientEvents` dispatch methods) are no longer part of the
public API.
* A Dart restart callback that throws is answered as "not supported" (it was reported to
Expand Down Expand Up @@ -53,7 +70,7 @@
* Measurement back-pressure: `maxInFlightFragments`, `Association.acknowledge`, automatic
acknowledgement in `MeasurementWorker`.
* `Association.readFile(onOpened:)` decides whether to continue once the size is known.
* `Dnp3Exception.detail` with the structured library error. `TimeSyncException.detail`
* `Dnp3Exception.detail` with the structured library error. **Breaking:** `TimeSyncException.detail`
(int) was renamed to `value`.
* ABI version 2.

Expand Down
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement by contacting the
maintainer, [@gencto](https://github.com/gencto), privately on GitHub.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
Loading
Loading