From 378845efd7f1818e919914b5644f08ee56a56fb7 Mon Sep 17 00:00:00 2001 From: chuanhao01 <34702921+chuanhao01@users.noreply.github.com> Date: Sun, 27 Sep 2020 15:16:59 +0800 Subject: [PATCH 1/8] adding Inital draft of main chapter README --- 09-tips-and-tricks/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 09-tips-and-tricks/README.md diff --git a/09-tips-and-tricks/README.md b/09-tips-and-tricks/README.md new file mode 100644 index 0000000..be3754c --- /dev/null +++ b/09-tips-and-tricks/README.md @@ -0,0 +1,11 @@ +# Tips and Tricks + +This chapter will be about some common tips and tricks you can use for your git setup. +These tips can be something as simple and generic as using bash aliases to someting very specific and complex, like integrating the `vscode` editor with git. + +Below is a quick reference table for all the tips in this guide. +You can refer to their respecitve sub-chapter guides for more information. + +| Tip | Description | Author | Link | +| --- | --- | --- | --- | +| Tip 1 | Some Description | [@author](#tips-and-tricks) | [Link](#tips-and-tricks) | From 21f5a30e4e946f87932b56e56e5510b5a60caf89 Mon Sep 17 00:00:00 2001 From: chuanhao01 <34702921+chuanhao01@users.noreply.github.com> Date: Sun, 27 Sep 2020 15:22:57 +0800 Subject: [PATCH 2/8] format table in main README --- 09-tips-and-tricks/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/09-tips-and-tricks/README.md b/09-tips-and-tricks/README.md index be3754c..1937065 100644 --- a/09-tips-and-tricks/README.md +++ b/09-tips-and-tricks/README.md @@ -6,6 +6,9 @@ These tips can be something as simple and generic as using bash aliases to somet Below is a quick reference table for all the tips in this guide. You can refer to their respecitve sub-chapter guides for more information. -| Tip | Description | Author | Link | -| --- | --- | --- | --- | -| Tip 1 | Some Description | [@author](#tips-and-tricks) | [Link](#tips-and-tricks) | +| Tip | Description | Author | Link | +|-------|------------------|-----------------------------|--------------------------| +| Tip 1 | Some Description | [@author](#tips-and-tricks) | [Link](#tips-and-tricks) | + + + From 143dace374b4dfc909f5489f1885229bf58c6264 Mon Sep 17 00:00:00 2001 From: chuanhao01 <34702921+chuanhao01@users.noreply.github.com> Date: Sun, 27 Sep 2020 15:25:57 +0800 Subject: [PATCH 3/8] adding short contribution steps for adding tips --- 09-tips-and-tricks/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/09-tips-and-tricks/README.md b/09-tips-and-tricks/README.md index 1937065..cb1b6d2 100644 --- a/09-tips-and-tricks/README.md +++ b/09-tips-and-tricks/README.md @@ -10,5 +10,9 @@ You can refer to their respecitve sub-chapter guides for more information. |-------|------------------|-----------------------------|--------------------------| | Tip 1 | Some Description | [@author](#tips-and-tricks) | [Link](#tips-and-tricks) | +## Contributing a tip +On top of following the guidelines in the [contributing](../CONTRIBUTING.md) document for a tip's sub-chapter, you should also: +- Make sure you add a short description and link to the quick reference table above +- Make a Pull Request indicating the tip you are adding From b6be6313be95de54596c9b9a9615cac1e53fd4c7 Mon Sep 17 00:00:00 2001 From: chuanhao01 <34702921+chuanhao01@users.noreply.github.com> Date: Mon, 28 Sep 2020 22:28:31 +0800 Subject: [PATCH 4/8] adding subchapter requirement in readme --- 09-tips-and-tricks/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/09-tips-and-tricks/README.md b/09-tips-and-tricks/README.md index cb1b6d2..e221a39 100644 --- a/09-tips-and-tricks/README.md +++ b/09-tips-and-tricks/README.md @@ -13,6 +13,7 @@ You can refer to their respecitve sub-chapter guides for more information. ## Contributing a tip On top of following the guidelines in the [contributing](../CONTRIBUTING.md) document for a tip's sub-chapter, you should also: +- Make sure the tip is added as a sub-chapter folder - Make sure you add a short description and link to the quick reference table above - Make a Pull Request indicating the tip you are adding From dede5ad01b58eeaed8a63599dccc1f08ff781bfb Mon Sep 17 00:00:00 2001 From: chuanhao01 <34702921+chuanhao01@users.noreply.github.com> Date: Mon, 28 Sep 2020 22:54:41 +0800 Subject: [PATCH 5/8] adding rule and date completed section --- 09-tips-and-tricks/README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/09-tips-and-tricks/README.md b/09-tips-and-tricks/README.md index e221a39..2ac9b6f 100644 --- a/09-tips-and-tricks/README.md +++ b/09-tips-and-tricks/README.md @@ -6,14 +6,17 @@ These tips can be something as simple and generic as using bash aliases to somet Below is a quick reference table for all the tips in this guide. You can refer to their respecitve sub-chapter guides for more information. -| Tip | Description | Author | Link | -|-------|------------------|-----------------------------|--------------------------| -| Tip 1 | Some Description | [@author](#tips-and-tricks) | [Link](#tips-and-tricks) | +| Tip | Description | Author | Date Completed | Link | +|-------|------------------|-----------------------------|----------------|--------------------------| +| Tip 1 | Some Description | [@author](#tips-and-tricks) | 01/01/2020 | [Link](#tips-and-tricks) | ## Contributing a tip On top of following the guidelines in the [contributing](../CONTRIBUTING.md) document for a tip's sub-chapter, you should also: - Make sure the tip is added as a sub-chapter folder -- Make sure you add a short description and link to the quick reference table above +- Make sure you add a short description, the date when the guide was finished(Inital finished date) and a link to the quick reference table above. +- Make sure the quick reference table is formatted properly (You can use [this](http://markdowntable.com/) website) +- Make sure the tip's sub-chapter updates are noted at the bottom of the tip +- Make sure the tip's references are given (if any) - Make a Pull Request indicating the tip you are adding From 35c1e00e70e072c37bbd8de7001a443ea8b65c6f Mon Sep 17 00:00:00 2001 From: chuanhao01 <34702921+chuanhao01@users.noreply.github.com> Date: Mon, 28 Sep 2020 22:58:09 +0800 Subject: [PATCH 6/8] added reference part for sub-chapter requirements --- 09-tips-and-tricks/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/09-tips-and-tricks/README.md b/09-tips-and-tricks/README.md index 2ac9b6f..7aaa0ad 100644 --- a/09-tips-and-tricks/README.md +++ b/09-tips-and-tricks/README.md @@ -13,7 +13,7 @@ You can refer to their respecitve sub-chapter guides for more information. ## Contributing a tip On top of following the guidelines in the [contributing](../CONTRIBUTING.md) document for a tip's sub-chapter, you should also: -- Make sure the tip is added as a sub-chapter folder +- Make sure the tip is added as a sub-chapter folder (You can use other tips or chapter's 7 sub-chapters as a reference) - Make sure you add a short description, the date when the guide was finished(Inital finished date) and a link to the quick reference table above. - Make sure the quick reference table is formatted properly (You can use [this](http://markdowntable.com/) website) - Make sure the tip's sub-chapter updates are noted at the bottom of the tip From c64fe2835faf96ccaa8c29abb24f56a8142cd422 Mon Sep 17 00:00:00 2001 From: Lim Chuan Hao <34702921+chuanhao01@users.noreply.github.com> Date: Sat, 31 Oct 2020 18:15:33 +0800 Subject: [PATCH 7/8] Apply suggestions from code review Minor changes for TIps and Tricks Main chapter's folder Co-authored-by: Woo Jia Hao --- 09-tips-and-tricks/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/09-tips-and-tricks/README.md b/09-tips-and-tricks/README.md index 7aaa0ad..8bb347e 100644 --- a/09-tips-and-tricks/README.md +++ b/09-tips-and-tricks/README.md @@ -1,6 +1,6 @@ # Tips and Tricks -This chapter will be about some common tips and tricks you can use for your git setup. +This chapter will be about some common tips and tricks you can use for your Git setup. These tips can be something as simple and generic as using bash aliases to someting very specific and complex, like integrating the `vscode` editor with git. Below is a quick reference table for all the tips in this guide. @@ -13,10 +13,9 @@ You can refer to their respecitve sub-chapter guides for more information. ## Contributing a tip On top of following the guidelines in the [contributing](../CONTRIBUTING.md) document for a tip's sub-chapter, you should also: -- Make sure the tip is added as a sub-chapter folder (You can use other tips or chapter's 7 sub-chapters as a reference) -- Make sure you add a short description, the date when the guide was finished(Inital finished date) and a link to the quick reference table above. +- Make sure the tip is added as a sub-chapter folder (You can use other tips or [chapter's 7](../07-advanced-git) sub-chapters as a reference) +- Make sure you add a short description, the date when the guide was finished (initial finished date) and a link to the quick reference table above. - Make sure the quick reference table is formatted properly (You can use [this](http://markdowntable.com/) website) - Make sure the tip's sub-chapter updates are noted at the bottom of the tip - Make sure the tip's references are given (if any) - Make a Pull Request indicating the tip you are adding - From f05a90604d6f8638819ed4cca1a88740b49a60e0 Mon Sep 17 00:00:00 2001 From: chuanhao01 <34702921+chuanhao01@users.noreply.github.com> Date: Sat, 31 Oct 2020 18:24:52 +0800 Subject: [PATCH 8/8] Some minor changes for clarity --- 09-tips-and-tricks/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/09-tips-and-tricks/README.md b/09-tips-and-tricks/README.md index 8bb347e..05c3904 100644 --- a/09-tips-and-tricks/README.md +++ b/09-tips-and-tricks/README.md @@ -12,10 +12,10 @@ You can refer to their respecitve sub-chapter guides for more information. ## Contributing a tip -On top of following the guidelines in the [contributing](../CONTRIBUTING.md) document for a tip's sub-chapter, you should also: -- Make sure the tip is added as a sub-chapter folder (You can use other tips or [chapter's 7](../07-advanced-git) sub-chapters as a reference) -- Make sure you add a short description, the date when the guide was finished (initial finished date) and a link to the quick reference table above. +On top of following the guidelines in the [CONTRIBUTING](../CONTRIBUTING.md) document for a tip's/trick's sub-chapter, you should also: +- Make sure the tip/trick is added as a sub-chapter folder (You can use other tips/tricks sub-chapters or [chapter's 7](../07-advanced-git) sub-chapters as a reference) +- Make sure you add a short description, the date when the guide was finished (initial finished date) and a link to the sub-chapter to the quick reference table above. - Make sure the quick reference table is formatted properly (You can use [this](http://markdowntable.com/) website) -- Make sure the tip's sub-chapter updates are noted at the bottom of the tip -- Make sure the tip's references are given (if any) -- Make a Pull Request indicating the tip you are adding +- Make sure the tip's/trick's sub-chapter updates are noted at the bottom of the tip's/trick's `README.md` +- Make sure the tip's/trick's references are given (if any) +- Make a Pull Request indicating the tip/trick sub-chapter you are adding