From 6244e440332efaec00a523c9dce5315f99f85721 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Vi=E1=BB=87t=20H=C6=B0ng?= Date: Thu, 18 Oct 2018 12:29:47 +0700 Subject: [PATCH 1/8] added pr template --- PULL_REQUEST_TEMPLATE.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..c769d23e --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,24 @@ +# Description + + +# Issue fixed + + +# Type of changes + +- [ ] Bug fix (Change that fixed an issue) +- [ ] Breaking change (Change that can cause existing functionality to change) +- [ ] Improvement (Change that improve the code. Maybe performance or development improvement) +- [ ] Feature (Change that add new functionality) +- [ ] Documentation change (Change that modify documentation. Maybe typo fixes) + +# Checklist: + +- [ ] My code follow the project code style +- [ ] I have written test for my code and it has been tested +- [ ] All existing tests has been passed +- [ ] I have attached a screenshot / video to visualize my change if possible From fa3700df7c6a2bd5de8f556fe5aaa4d5c7394e89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Vi=E1=BB=87t=20H=C6=B0ng?= Date: Thu, 18 Oct 2018 12:33:54 +0700 Subject: [PATCH 2/8] updated pr template --- PULL_REQUEST_TEMPLATE.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index c769d23e..5b61ccb7 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1,18 @@ # Description # Issue fixed + # Type of changes - [ ] Bug fix (Change that fixed an issue) From 80c4601fdcc8603eae370869a7a646654caf8fc8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Vi=E1=BB=87t=20H=C6=B0ng?= Date: Thu, 18 Oct 2018 12:36:21 +0700 Subject: [PATCH 3/8] fixed grammar in PR template --- PULL_REQUEST_TEMPLATE.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 5b61ccb7..8fff1f32 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,7 @@ # Description # Issue fixed @@ -17,13 +17,13 @@ your PR will be reviewed faster if we know exactly what it does. - [ ] Bug fix (Change that fixed an issue) - [ ] Breaking change (Change that can cause existing functionality to change) -- [ ] Improvement (Change that improve the code. Maybe performance or development improvement) -- [ ] Feature (Change that add new functionality) -- [ ] Documentation change (Change that modify documentation. Maybe typo fixes) +- [ ] Improvement (Change that improves the code. Maybe performance or development improvement) +- [ ] Feature (Change that adds new functionality) +- [ ] Documentation change (Change that modifies documentation. Maybe typo fixes) # Checklist: -- [ ] My code follow the project code style +- [ ] My code follows the project code style - [ ] I have written test for my code and it has been tested -- [ ] All existing tests has been passed -- [ ] I have attached a screenshot / video to visualize my change if possible +- [ ] All existing tests have been passed +- [ ] I have attached a screenshot/video to visualize my change if possible From 83243b61a64ba96a53f98b6094abf1f0d5bb3aa6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Vi=E1=BB=87t=20H=C6=B0ng?= Date: Thu, 18 Oct 2018 12:39:57 +0700 Subject: [PATCH 4/8] smaller header font size --- PULL_REQUEST_TEMPLATE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 8fff1f32..6aa1bb63 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,10 @@ -# Description +## Description -# Issue fixed +## Issue fixed @@ -13,7 +13,7 @@ Please list out all issue fixed with this PR here. Please make sure you fill in these checkboxes, your PR will be reviewed faster if we know exactly what it does. --> -# Type of changes +## Type of changes - [ ] Bug fix (Change that fixed an issue) - [ ] Breaking change (Change that can cause existing functionality to change) @@ -21,7 +21,7 @@ your PR will be reviewed faster if we know exactly what it does. - [ ] Feature (Change that adds new functionality) - [ ] Documentation change (Change that modifies documentation. Maybe typo fixes) -# Checklist: +## Checklist: - [ ] My code follows the project code style - [ ] I have written test for my code and it has been tested From 3b7bedbbe8ffcfbde5555214c2252380f0caa866 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Vi=E1=BB=87t=20H=C6=B0ng?= Date: Sun, 21 Oct 2018 10:25:28 +0700 Subject: [PATCH 5/8] update pull request message --- PULL_REQUEST_TEMPLATE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 6aa1bb63..04af5f29 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -12,6 +12,8 @@ Please list out all issue fixed with this PR here. ## Type of changes From c5554e8f1e6e398eee7a31d936ba7289b3a72978 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Vi=E1=BB=87t=20H=C6=B0ng?= Date: Thu, 25 Oct 2018 23:36:31 +0700 Subject: [PATCH 6/8] update pull request template --- PULL_REQUEST_TEMPLATE.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 04af5f29..5e12f164 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -13,19 +13,19 @@ Please list out all issue fixed with this PR here. Please make sure you fill in these checkboxes, your PR will be reviewed faster if we know exactly what it does. -Put an `x` in all the boxes that apply. +Change :white_circle: to :radio_button: in all the options that apply --> ## Type of changes -- [ ] Bug fix (Change that fixed an issue) -- [ ] Breaking change (Change that can cause existing functionality to change) -- [ ] Improvement (Change that improves the code. Maybe performance or development improvement) -- [ ] Feature (Change that adds new functionality) -- [ ] Documentation change (Change that modifies documentation. Maybe typo fixes) +- :white_circle: Bug fix (Change that fixed an issue) +- :white_circle: Breaking change (Change that can cause existing functionality to change) +- :white_circle: Improvement (Change that improves the code. Maybe performance or development improvement) +- :white_circle: Feature (Change that adds new functionality) +- :white_circle: Documentation change (Change that modifies documentation. Maybe typo fixes) ## Checklist: -- [ ] My code follows the project code style -- [ ] I have written test for my code and it has been tested -- [ ] All existing tests have been passed -- [ ] I have attached a screenshot/video to visualize my change if possible +- :white_circle: My code follows the project code style +- :white_circle: I have written test for my code and it has been tested +- :white_circle: All existing tests have been passed +- :white_circle: I have attached a screenshot/video to visualize my change if possible From 6cb6cd3f261aca0af0fa00a3069efad63b35caf1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Vi=E1=BB=87t=20H=C6=B0ng?= Date: Fri, 26 Oct 2018 00:06:06 +0700 Subject: [PATCH 7/8] updated docs and pull request template --- PULL_REQUEST_TEMPLATE.md | 7 ++++- contributing.md | 18 ++++++++++-- docs/code_style.md | 60 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 81 insertions(+), 4 deletions(-) create mode 100644 docs/code_style.md diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 5e12f164..58df576a 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,8 @@ + ## Description