From ea07cf6c89a28c0b7e2d2edf61c6d68a7abae74c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81=28Buo-ren=20Lin=29?= Date: Thu, 13 Sep 2018 16:24:47 +0800 Subject: [PATCH 1/6] Contributing Guidelines: Improve coding style requirement MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 林博仁(Buo-ren, Lin) --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6146b4f..74f8e9d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ Refer to the following articles for reference on writing manpages: There are so many aspects of the code that can be improved, however, please consider the following topics while doing so. ### Coding Style -It is required to mimic the coding style of the current code +While we don't really have a strictly unifeid style throughout the codebsae, it is required to *mimic the coding style of the code in context*. #### Indentation This project uses tab characters for indentation as it's width can be flexibly configured in many text editors From adc74923b5c3c66ad30f84621a6931a7398b4dd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81=28Buo-ren=20Lin=29?= Date: Thu, 13 Sep 2018 16:26:53 +0800 Subject: [PATCH 2/6] Contributing Guidelines: Imrpove promote and design sections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 林博仁(Buo-ren, Lin) --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 74f8e9d..52e8e89 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,10 +58,10 @@ NOTE: This currently only applies to the GNU Bash shell scripts. We use UTF-8 encoding for all of our files ## Promote This Project to Others -It is appreciated if you share this project with others. Also, if you write an article about this project, plese share it with us, we'd love to hear about it! +It is appreciated if you share this project with others. Also, if you write an article about this project, plese [share it with us](https://github.com/slacka/WoeUSB/wiki/Public-Reactions), we'd love to hear about it! ## Design Artwork/Logos for This Software -All current artwork is stored under src/data. Please only use materials that are under a free license. +All current artwork is stored under src/data. **Please only use materials that are under a free license.** ## Hints on Using the Git VCS ### Create commits based on minimal independent changes From ed254847da311620503a1aef1ccf9b65cfa19286 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81=28Buo-ren=20Lin=29?= Date: Thu, 13 Sep 2018 16:33:05 +0800 Subject: [PATCH 3/6] Contributing Guidelines: Improve Character Encoding Section; Fix heading capitalization MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 林博仁(Buo-ren, Lin) --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52e8e89..b8d2bbf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,8 +54,8 @@ NOTE: This currently only applies to the GNU Bash shell scripts. * Function parameters should be caught by `local` parameters instead of directly referenced using positional parameter syntax * To increase code reusability, avoid referencing global variables from a function, alway pass it by function arguments -### Character Encoding of Files -We use UTF-8 encoding for all of our files +### Character Encoding of Plaintext Files +[UTF-8 everywhere!](https://utf8everywhere.org) (Unless otherwise mandated by its specification) ## Promote This Project to Others It is appreciated if you share this project with others. Also, if you write an article about this project, plese [share it with us](https://github.com/slacka/WoeUSB/wiki/Public-Reactions), we'd love to hear about it! @@ -63,8 +63,8 @@ It is appreciated if you share this project with others. Also, if you write an ## Design Artwork/Logos for This Software All current artwork is stored under src/data. **Please only use materials that are under a free license.** -## Hints on Using the Git VCS -### Create commits based on minimal independent changes +## Guidelines in Using Git SCM +### Create Commits Based on Minimal Independent Changes Avoid creating commits that do multiple things at once as this will help other developers understand the change history. ### Write Comprehensible Commit Messages From 89f0c31587bbb6d4b88a306215a734a22e6e6516 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81=28Buo-ren=20Lin=29?= Date: Thu, 13 Sep 2018 17:03:42 +0800 Subject: [PATCH 4/6] Contribution Guidelines: Improve commit messages section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 林博仁(Buo-ren, Lin) --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b8d2bbf..00592ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,6 +68,9 @@ All current artwork is stored under src/data. **Please only use materials that Avoid creating commits that do multiple things at once as this will help other developers understand the change history. ### Write Comprehensible Commit Messages -Use concrete language on what the commit does in the commit message. +While we currently don't have a strict commit message style, we do have established some requirements: -### Avoid Changing History That Has Been Pushed to Remote Repository +* Every contribution must conform to the [Developer Certificate of Origin](https://elinux.org/Developer_Certificate_Of_Origin), version 1.1 or more recent version, and is signed off using the `Signed-off-by: ` tag +* Use English for commit messages + +For summary line format, [refer and mimic the commit log](https://github.com/slacka/WoeUSB/commits/master). Also check out the [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) article for additional info on writing commit messages. From aab0d972b1a236f61b2cffdf86d0531cc6828114 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81=28Buo-ren=20Lin=29?= Date: Thu, 13 Sep 2018 17:05:05 +0800 Subject: [PATCH 5/6] Contributing Guidelines: Allow contributor to skip unrelated sections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 林博仁(Buo-ren, Lin) --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 00592ba..4f58ca3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ # Contributing Guidelines -This document explains how to contribute to this project in many aspects. Please make sure to read this thoroughly before making any contributions. +This document explains how to contribute to this project in many aspects. Please make sure to read the relating sections thoroughly before making any contributions. ## Reporting Issues The so-called "issue" includes but is not limited to software bugs and suggestions From 75fbe97eef215c69fa5e436059d428eb93fe2bdf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81=28Buo-ren=20Lin=29?= Date: Fri, 14 Sep 2018 16:53:12 +0800 Subject: [PATCH 6/6] Fix regression due to changing type of only_for_gui MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We changed only_for_gui from integer to string (true/false), but missed the type assignment from the function argument. Fixes #207. Refer-to: WoeUSB crashed due to improper parameter type assignment · Issue #207 · slacka/WoeUSB Signed-off-by: 林博仁(Buo-ren Lin) --- src/woeusb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/woeusb b/src/woeusb index 9b75e1c..6611d06 100755 --- a/src/woeusb +++ b/src/woeusb @@ -1345,7 +1345,7 @@ copy_filesystem_files(){ util_check_function_parameters_quantity 3 "${#}" local source_fs_mountpoint="${1}"; shift local target_fs_mountpoint="${1}"; shift - local -ir only_for_gui="${1}" + local -r only_for_gui="${1}" local -i total_size total_size=$(