зеркало из
https://github.com/glebtv/tui-textarea.git
synced 2026-09-07 16:05:50 +03:00
add contributing guide
Этот коммит содержится в:
16
CONTRIBUTING.md
Обычный файл
16
CONTRIBUTING.md
Обычный файл
@@ -0,0 +1,16 @@
|
|||||||
|
Please ensure that all tests and linter checks passed on your branch before creating a PR which modifies some source files.
|
||||||
|
|
||||||
|
To run tests:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo test -- --skip src/lib.rs
|
||||||
|
```
|
||||||
|
|
||||||
|
`--skip` is necessary since `cargo test` tries to run code blocks in [README file](./README.md).
|
||||||
|
|
||||||
|
To run linters:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo clippy --all-features --examples
|
||||||
|
cargo fmt -- --check
|
||||||
|
```
|
||||||
15
README.md
15
README.md
@@ -149,8 +149,8 @@ let mut textarea = TextArea::new(lines);
|
|||||||
from any iterators whose elements can be converted to `String`.
|
from any iterators whose elements can be converted to `String`.
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
// Create `TextArea` from from `&[&str]`
|
// Create `TextArea` from from `[&str]`
|
||||||
let mut textarea = TextArea::from(&[
|
let mut textarea = TextArea::from([
|
||||||
"this is first line",
|
"this is first line",
|
||||||
"this is second line",
|
"this is second line",
|
||||||
"this is third line",
|
"this is third line",
|
||||||
@@ -467,10 +467,12 @@ loop {
|
|||||||
|
|
||||||
## Contributing to tui-textarea
|
## Contributing to tui-textarea
|
||||||
|
|
||||||
For feature requests or bug reports, please create an issue on GitHub. For submitting patches, please create a pull
|
This project is developed [on GitHub][repo].
|
||||||
request on GitHub.
|
|
||||||
|
|
||||||
https://github.com/rhysd/tui-textarea
|
For feature requests or bug reports, please [create an issue][new-issue]. For submitting patches, please [create a pull
|
||||||
|
request][pulls].
|
||||||
|
|
||||||
|
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) before making a PR.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
@@ -482,3 +484,6 @@ tui-textarea is distributed under [The MIT License](./LICENSE.txt).
|
|||||||
[crosster]: https://docs.rs/crossterm/latest/crossterm/
|
[crosster]: https://docs.rs/crossterm/latest/crossterm/
|
||||||
[doc]: https://docs.rs/tui-textarea/latest/tui_textarea
|
[doc]: https://docs.rs/tui-textarea/latest/tui_textarea
|
||||||
[tui-backend]: https://docs.rs/tui/latest/tui/backend/trait.Backend.html
|
[tui-backend]: https://docs.rs/tui/latest/tui/backend/trait.Backend.html
|
||||||
|
[repo]: https://github.com/rhysd/tui-textarea
|
||||||
|
[new-issue]: https://github.com/rhysd/tui-textarea/issues/new
|
||||||
|
[pulls]: https://github.com/rhysd/tui-textarea/pulls
|
||||||
|
|||||||
Ссылка в новой задаче
Block a user