kingchencandGitHub
d59cd44043
* docs: standardise language naming and add binding security sections Canonical binding list everywhere: Rust, Python, Node.js, WASM, C, C++, C#, Go, Java, R. Use C# (not .NET) as the language label, WASM (not WebAssembly) in prose, and frame the C ABI as a hub rather than a list item. - Bump stale indicator counts (200+ -> 514) and family count (sixteen -> twenty-four) in the Node/Python/WASM and docs READMEs. - Add a short Security section to all eight binding READMEs. - Relabel benchmark rows (C -> C / C++, C# / .NET -> C#). - Fix the 'language stecker' wording in the C#/Go/R API intros. - Documentation only; no code or public API changes. * release.yml: extend install snippets and expose version output Add the missing registry installs to the release body (dotnet, go, Gradle/ Maven Central, r-universe) alongside cargo/pip/npm, and expose a v-stripped 'version' output from the tag step for the Gradle coordinate. Also fix the C-ABI language order in the assets note (C# before Go). * release.yml: correct the release body (10 languages, all registries) Reframe the tagline to '10 languages' (native Rust/Python/Node.js/WASM + a C ABI hub for C, C++, C#, Go, Java, R) instead of '4 language registries', note that C#/Java/Go/R publish to NuGet/Maven/Go/r-universe via their own jobs, and tidy the Node.js label and the C-ABI hub list.
73 lines
2.2 KiB
Markdown
73 lines
2.2 KiB
Markdown
<!--
|
||
Thanks for contributing to Wickra!
|
||
Please fill in the sections below. Delete any that don't apply.
|
||
-->
|
||
|
||
## Summary
|
||
|
||
<!-- 1–3 sentences: what does this PR change and why? -->
|
||
|
||
## Type of change
|
||
|
||
- [ ] Bug fix (Non-breaking change which fixes an issue)
|
||
- [ ] New feature (Non-breaking change which adds functionality)
|
||
- [ ] Breaking change (Fix or feature that changes existing public API)
|
||
- [ ] Performance improvement
|
||
- [ ] Refactor (No functional change)
|
||
- [ ] Documentation only
|
||
- [ ] CI / build / tooling
|
||
|
||
## Affected surfaces
|
||
|
||
- [ ] Rust crate (`crates/wickra`)
|
||
- [ ] Python binding (`bindings/python`)
|
||
- [ ] Node.js binding (`bindings/node`)
|
||
- [ ] WASM binding (`bindings/wasm`)
|
||
- [ ] C ABI (`bindings/c`)
|
||
- [ ] C# binding (`bindings/csharp`)
|
||
- [ ] Go binding (`bindings/go`)
|
||
- [ ] Java binding (`bindings/java`)
|
||
- [ ] R binding (`bindings/r`)
|
||
- [ ] Examples / docs
|
||
|
||
## Linked issues
|
||
|
||
<!-- "Closes #123", "Refs #456". One per line. -->
|
||
|
||
Closes #
|
||
|
||
## How was this tested?
|
||
|
||
<!--
|
||
- Unit tests added / updated under `crates/*/tests/` or `bindings/*/tests/`
|
||
- Property / fuzz tests touched? (Under `fuzz/`)
|
||
- Manual repro steps, if applicable
|
||
- Benchmarks run (Paste before/after if perf-sensitive)
|
||
-->
|
||
|
||
## Numerical correctness (If you touched an indicator)
|
||
|
||
- [ ] Output matches an existing reference (TA-Lib, paper, prior Wickra release) within documented tolerance
|
||
- [ ] Streaming `update()` matches batch / `from_slice` output on the same input
|
||
- [ ] Edge cases covered: empty input, single point, NaN, leading warm-up window
|
||
|
||
## Performance impact (If applicable)
|
||
|
||
| Benchmark | Before | After | Δ |
|
||
| --------- | ------ | ----- | - |
|
||
| | | | |
|
||
|
||
## Checklist
|
||
|
||
- [ ] `cargo fmt --all` and `cargo clippy --all-targets -- -D warnings` are clean
|
||
- [ ] `cargo test --workspace` passes locally
|
||
- [ ] Binding tests run (If a binding changed)
|
||
- [ ] Public API changes are reflected in `CHANGELOG.md`
|
||
- [ ] Public API changes are reflected in rustdoc / README / examples
|
||
- [ ] No `todo*.md` or other local-only notes are staged
|
||
- [ ] License header / `LICENSE` reference unchanged (MIT OR Apache-2.0)
|
||
|
||
## Notes for reviewers
|
||
|
||
<!-- Anything reviewers should look at first, known follow-ups, deliberately out-of-scope items. -->
|