Update CONTRIBUTING.md
Fix links and apply monorepoizing.
@@ -5,7 +5,7 @@ Here's the useful information about contributing to Plotters.
# License
The `Plotters` project is under MIT license.
-You may interested in reading [the full text of the license](https://github.com/38/plotters/blob/master/LICENSE).
+You may interested in reading [the full text of the license](https://github.com/plotters-rs/plotters/blob/master/LICENSE).
If you have any questions or concerns please contact us at <haohou302@gmail.com>.
# Contributing to Plotters codebase
@@ -25,17 +25,18 @@ Before you finalize your PR, please check the following thing:
- 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)
```bash
+ cd plotters
cargo test --doc
cargo build --release --examples
for i in examples/*.rs
do
- ./target/release/examples/$(basename $i .rs)
+ ../target/release/examples/$(basename $i .rs)
done
cd plotters-doc-data
git status
```
-- 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.
+- 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.
## Does my code meet the styling guidelines
@@ -57,7 +58,7 @@ fn foo(param_1: u32, param_2: u32) -> u32{ 0 }
## Top Level Documentation and Readme
Please notice we put almost same content for top level `rustdoc` and `README.md`. Thus the both part are generated by script.
-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
+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
use the following command to synchronize the doc to both `src/lib.rs` and `README.md`.
```bash
@@ -127,5 +128,3 @@ Usage:
cargo tarpaulin --all-features --run-types Tests Doctests -o Xml --output-dir target/test
pycobertura show target/test/cobertura.xml
```
-
-
