You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ Here's the useful information about contributing to Plotters.
5
5
# License
6
6
7
7
The `Plotters` project is under MIT license.
8
-
You may interested in reading [the full text of the license](https://github.com/38/plotters/blob/master/LICENSE).
8
+
You may interested in reading [the full text of the license](https://github.com/plotters-rs/plotters/blob/master/LICENSE).
9
9
If you have any questions or concerns please contact us at <[email protected]>.
10
10
11
11
# Contributing to Plotters codebase
@@ -25,17 +25,18 @@ Before you finalize your PR, please check the following thing:
25
25
- Please run the following command to check if the example output changes. (There shouldn't be any change if you are not modifying the layout)
26
26
27
27
```bash
28
+
cd plotters
28
29
cargo test --doc
29
30
cargo build --release --examples
30
31
foriin examples/*.rs
31
32
do
32
-
./target/release/examples/$(basename $i .rs)
33
+
../target/release/examples/$(basename $i .rs)
33
34
done
34
35
cd plotters-doc-data
35
36
git status
36
37
```
37
38
38
-
- Please make sure the WASM target works as well. The easiest way to do that is try to run our WASM demo under [examples/wasm-demo](https://github.com/38/plotters/blob/master/examples/wasm-demo) directory and follow the instruction in the `README.md` file under that directory.
39
+
- Please make sure the WASM target works as well. The easiest way to do that is try to run our WASM demo under [`plotters/examples/wasm-demo`](https://github.com/plotters-rs/plotters/tree/master/plotters/examples/wasm-demo) directory and follow the instruction in the [`README.md`](./plotters/examples/wasm-demo/README.md) file under that directory.
Please notice we put almost same content for top level `rustdoc` and `README.md`. Thus the both part are generated by script.
60
-
If you need to modify the readme and documentation, please change the template at [doc-template/readme.template.md](https://github.com/38/plotters/blob/master/doc-template/readme.template.md) and
61
+
If you need to modify the readme and documentation, please change the template at [`plotters/doc-template/readme.template.md`](https://github.com/plotters-rs/plotters/blob/master/doc-template/readme.template.md) and
61
62
use the following command to synchronize the doc to both `src/lib.rs` and `README.md`.
62
63
63
64
```bash
@@ -127,5 +128,3 @@ Usage:
127
128
cargo tarpaulin --all-features --run-types Tests Doctests -o Xml --output-dir target/test
0 commit comments