archive-gh-me/yew
1
0
Fork 0
mirror of https://github.com/yewstack/yew.git synced 2025-12-08 21:26:25 +00:00
Code Issues Projects Releases Wiki Activity

Remove outdated benchmarking information in CONTRIBUTING.md (#3059)

Browse Source
This commit is contained in:
Kai Salmon 2023-04-02 20:27:39 +01:00 committed by GitHub
parent 36aaecc430
commit 8086a73a21
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -69,22 +69,10 @@ To automatically fix formatting issues, run `cargo +nightly fmt` first.
## Benchmarks
If you wish to improve the performance of Yew, we ask you to prove the improvements of your changes through benchmarking.
Some components of Yew have dedicated benchmarks which can be run with the following command:
```bash
cargo make benchmarks
```
There's also a benchmark for the framework as a whole.
js-framework-benchmark is used as a benchmark for the framework as a whole.
Simply clone [bakape/js-framework-benchmark](https://github.com/bakape/js-framework-benchmark)
and follow the repository's README.
Feel free to add new benchmark tests if the current benchmark coverage is insufficient!
> See #1453 for a discussion on how to make this easier.
## Writing APIs
When building new APIs, think about what it would be like to use them. Would this API cause confusing and hard to pin error mesages? Would this API integrate well with other APIs? Is it intuitive to use this API?