Skip to content

Commit 7095106

Browse files
committed
Merge branch 'master' of ssh://github.com/38/plotters
2 parents 6fefd2b + 93e65c4 commit 7095106

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Here's the useful information about contributing to Plotters.
55
# License
66

77
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).
99
If you have any questions or concerns please contact us at <[email protected]>.
1010

1111
# Contributing to Plotters codebase
@@ -25,17 +25,18 @@ Before you finalize your PR, please check the following thing:
2525
- 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)
2626

2727
```bash
28+
cd plotters
2829
cargo test --doc
2930
cargo build --release --examples
3031
for i in examples/*.rs
3132
do
32-
./target/release/examples/$(basename $i .rs)
33+
../target/release/examples/$(basename $i .rs)
3334
done
3435
cd plotters-doc-data
3536
git status
3637
```
3738

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.
3940

4041
## Does my code meet the styling guidelines
4142

@@ -57,7 +58,7 @@ fn foo(param_1: u32, param_2: u32) -> u32{ 0 }
5758
## Top Level Documentation and Readme
5859

5960
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
6162
use the following command to synchronize the doc to both `src/lib.rs` and `README.md`.
6263

6364
```bash
@@ -127,5 +128,3 @@ Usage:
127128
cargo tarpaulin --all-features --run-types Tests Doctests -o Xml --output-dir target/test
128129
pycobertura show target/test/cobertura.xml
129130
```
130-
131-

0 commit comments

Comments
 (0)