2024-04-10 23:45:01 +08:00
|
|
|
# Contributing to Zng
|
|
|
|
|
|
|
|
|
|
Thank you for your interest in contributing to Zng! There are many ways to contribute
|
|
|
|
|
and we appreciate all of them.
|
|
|
|
|
|
|
|
|
|
### Review Our English
|
|
|
|
|
|
|
|
|
|
None of the core developers are native speakers, if you see any grammar mistake, typo
|
|
|
|
|
or sentence that doesn't read right don't hesitate to create a pull request.
|
|
|
|
|
|
|
|
|
|
### Report a Bug
|
|
|
|
|
|
|
|
|
|
Create an issue, provide a minimal reproducible example (MRE) that triggers the issue,
|
|
|
|
|
if manual interaction needs to happen, provide a list of steps to follow to cause the issue.
|
|
|
|
|
|
2024-04-11 02:20:05 +08:00
|
|
|
The issue must happen in the latest release or newer (master branch) and after running `cargo update`.
|
2024-04-10 23:45:01 +08:00
|
|
|
|
|
|
|
|
### Close a Todo
|
|
|
|
|
|
|
|
|
|
The project is under active development, the [todo] issue label tracks things that need to
|
2024-04-18 00:19:59 +08:00
|
|
|
be implemented. To claim a todo open a draft pull request that references the issue or leave a comment.
|
2024-04-10 23:45:01 +08:00
|
|
|
|
|
|
|
|
If you need help getting started leave a comment under the todo issue or start a [new discussion].
|
|
|
|
|
|
2024-04-18 00:19:59 +08:00
|
|
|
## Project Overview
|
|
|
|
|
|
2024-04-18 10:17:32 +08:00
|
|
|
The [`examples`] README provides a list of examples with screenshots and instruction on how to contribute an example.
|
2024-04-18 00:19:59 +08:00
|
|
|
|
2024-04-18 10:17:32 +08:00
|
|
|
The [`crates`] README provides an overview of the public crates.
|
2024-04-18 00:19:59 +08:00
|
|
|
|
2024-04-18 10:17:32 +08:00
|
|
|
The [`tools`] README provides an overview of the tools used to manage the project, in
|
2024-04-30 10:41:42 +08:00
|
|
|
particular the `cargo do` tool that must be used for testing.
|
2024-04-18 00:19:59 +08:00
|
|
|
|
2024-04-18 10:17:32 +08:00
|
|
|
The [`tests`] README provides an overview of integration and macro tests.
|
2024-04-18 00:19:59 +08:00
|
|
|
|
|
|
|
|
### VSCode & Rust Analyzer
|
|
|
|
|
|
|
|
|
|
Some workspace settings are included in the repository, in particular, `rust-analyzer` "checkOnSave"
|
|
|
|
|
and runnables are redirected to the `do` tool.
|
|
|
|
|
|
2024-04-18 10:17:32 +08:00
|
|
|
[`API docs`]: https://zng-ui.github.io/doc/zng/
|
2024-04-18 00:19:59 +08:00
|
|
|
[`cargo-expand`]: https://github.com/dtolnay/cargo-expand
|
|
|
|
|
[`cargo-asm`]: https://github.com/gnzlbg/cargo-asm
|
|
|
|
|
|
2024-04-10 23:45:01 +08:00
|
|
|
[todo]: https://github.com/zng-ui/zng/issues?q=is%3Aissue+is%3Aopen+label%3Atodo
|
2024-04-18 00:19:59 +08:00
|
|
|
[new discussion]: https://github.com/zng-ui/zng/discussions/new?category=general
|
2024-04-18 10:17:32 +08:00
|
|
|
[`examples`]: examples#adding-an-example
|
|
|
|
|
[`crates`]: crates#readme
|
|
|
|
|
[`tools`]: tools#readme
|
|
|
|
|
[`tests`]: tests#readme
|
