From a1a4d1a452fca5ecc1dae3e3f0a2e77d7e7391b1 Mon Sep 17 00:00:00 2001 From: Kevin Zhuang Date: Fri, 17 Jul 2020 10:36:40 +1000 Subject: [PATCH] docs: update doc links --- CHANGELOG.md | 2 +- CONTRIBUTING.md | 2 +- README.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b81255..409387c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,7 @@ Noteble changes are documentated in this file. - zsh completion for git commands - bash completion for git commands - fgrep: grep words within tracked dotfiles and edit them through EDITOR - More info will be documentated in wiki. + More info is documented in wiki. ### Changed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e22101c..186140a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,7 +74,7 @@ There is no requirements for the changes to be unit tested, bash unit test is na Just make sure you have thoroughly tested manually and pass shellcheck. -If you are interested, checkout [here] to see how the unit test are implemented and +If you are interested, checkout [here](https://github.com/kazhala/dotbare/blob/master/tests/README.md) to see how the unit test are implemented and use current unit tests as reference. ## Finally diff --git a/README.md b/README.md index ff2c786..3e91009 100644 --- a/README.md +++ b/README.md @@ -410,7 +410,7 @@ Latest changes are documented in CHANGELOG.md. View the upcoming changes in the ## Testing `dotbare` is unit tested using [bats](https://github.com/bats-core/bats-core). Mock tests are implemented using PATH override method. -This is documented [here] for better readability and extensibility. +This is documented [here](https://github.com/kazhala/dotbare/blob/master/tests/README.md) for better readability and extensibility. Not all functions have 100% coverage and lots of user interaction cannot be effectively tested, please fire up issues if something went wrong. @@ -419,7 +419,7 @@ you could checkout my cloudformation [template](https://github.com/kazhala/AWSCl ## Contributing -Checkout out [CONTRIBUTING.md] to see how you could contribute to `dotbare`. PRs are +Checkout out [CONTRIBUTING.md](https://github.com/kazhala/dotbare/blob/master/CONTRIBUTING.md) to see how you could contribute to `dotbare`. PRs are welcome and I'm happy to improve/extend `dotbare`'s functionality. Don't forget to leave a star :)