Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(:kr:): titles of decision-record-template-for-business-case #69

Conversation

flavono123
Copy link
Collaborator

  • 수준:
    • meaning of level in Korean
    • more natural expression when 'level' is used only itself
      • without an object??, such as the top-level developer
    • so,
      • 상위 -> 상위 수준
      • 하위 -> 하위 수준
  • (최)
    • omit since it means the most but not necessary in this case
    • 최상위 -> 상위
  • 상세 내용
    • 심층 다이빙 seems mis-translating from a machine translation
    • unnartural expression
    • translate 'deep-dive' as 'detail'

- 수준:
  - meaning of level in Korean
  - more natural expression when 'level' is used only itself
    - without an object??, such as the top-level `developer`
  - so,
    - 상위 -> 상위 수준
    - 하위 -> 하위 수준
- (최)
  - omit since it means the `most` but not necessary in this case
  - 최상위 -> 상위
- 상세 내용
  - 심층 다이빙 seems mis-translating from a machine translation
  - unnartural expression
  - translate 'deep-dive' as 'detail'
@@ -134,4 +134,3 @@
* 요약

* 세부 사항

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is another removing trailing white spaces.
my local workspace has configured like this and it applied when i save the file.

  • if i can remember, in future, i would check the diff just after saving a file gonna be edited.
  • but i think this minor changes can be done on this time together :)
  • or i can do that for the whole files at once if you want.

@joelparkerhenderson
Copy link
Owner

Thanks! I'll merge now.

Next I'll look for options for dealing with trailing spaces and leading/trailing blank lines, such as with a git commit hook, or sed script, etc. Do you have a solution that you like?

@joelparkerhenderson joelparkerhenderson merged commit a4b01d6 into joelparkerhenderson:main Nov 9, 2023
@flavono123 flavono123 deleted the doc/translate-in-korean/decision-record-template-for-business-case/level-deep-dive branch November 14, 2023 02:02
@flavono123
Copy link
Collaborator Author

by my vscode settings since i use that editor:

{
...
  // force EOF newline, trim trailing whitespace
  "files.insertFinalNewline": true,
  "files.trimTrailingWhitespace": true,
...
}

but we cannot enforce the "editor" for this works i think.
i guess there are more general solutions, such as git hook, as you said.

@flavono123
Copy link
Collaborator Author

flavono123 added a commit to flavono123/architecture-decision-record that referenced this pull request Nov 14, 2023
\### Goal

- reduce the tedious chore of removing trailing whitespaces
- ref. joelparkerhenderson#69 (comment)

\### Descriptions

- add pre-commit hook to remove trailing whitespaces
- flow
  - collect the staged files
  - check if any of these files have whitespace issues
  - if so, cleanup process
    - loop through the files and apply git-stripspace

\### Requirements

- `git config core.hooksPath .githooks` to activate the hook
- `git config core.quotepath false` for non-ascii paths
  - also need to be documented(where?)

\### Test
- trailing spaces in following diff are cleaned up
  - works on all type of file even for codes, not only for markdowns(docs)
```diff
diff --git a/.githooks/pre-commit b/.githooks/pre-commit
new file mode 100644
index 0000000..4d25c49
--- /dev/null
+++ b/.githooks/pre-commit
@@ -0,0 +1,37 @@
+#!/bin/sh
+
+# Temporary file to store the list of files that need cleanup
+TEMP_FILE=$(mktemp)
+
+# Collect staged files with potential whitespace issues
+git diff --cached --name-only --diff-filter=ACM > "$TEMP_FILE"
+
+# Check if any of these files have whitespace issues
+NEEDS_CLEANUP=false
+while read -r FILE; do
+  if ! git diff --cached --check -- "$FILE"; then
+    NEEDS_CLEANUP=true
+    break
+  fi
+done < "$TEMP_FILE"
+
+# Cleanup process
+if [ "$NEEDS_CLEANUP" = true ]; then
+  # Loop through the files and apply git-stripspace
+  while read -r FILE; do
+    git show ":$FILE" | git stripspace > "$FILE"
+    git add "$FILE"
+  done < "$TEMP_FILE"
+
+  # Inform the user
+  echo 'Cleanup trailing whitespaces is done'
+fi
+
+# Clean up - remove the temporary file
+rm "$TEMP_FILE"
+
+if [ "$NEEDS_CLEANUP" = false ]; then
+  echo "no need to cleanup"
+fi
+# Continue with the original commit
+exit 0
diff --git "a/locales/ko/\355\205\234\355\224\214\353\246\277/\352\262\260\354\240\225 \352\270\260\353\241\235 \355\205\234\355\224\214\353\246\277\353\263\204 edgex/index.md" "b/locales/ko/\355\205\234\355\224\214\353\246\277/\352\262\260\354\240\225 \352\270\260\353\241\235 \355\205\234\355\224\214\353\246\277\353\263\204 edgex/index.md"
index f4c35a5..bdbed75 100644
--- "a/locales/ko/\355\205\234\355\224\214\353\246\277/\352\262\260\354\240\225 \352\270\260\353\241\235 \355\205\234\355\224\214\353\246\277\353\263\204 edgex/index.md"
+++ "b/locales/ko/\355\205\234\355\224\214\353\246\277/\352\262\260\354\240\225 \352\270\260\353\241\235 \355\205\234\355\224\214\353\246\277\353\263\204 edgex/index.md"
@@ -5,7 +5,7 @@ EdgeX Foundry의 ADR 템플릿입니다.
 출처: https://docs.edgexfoundry.org/2.3/design/adr/template/

-### 제출자
+### 제출자

 ADR 제출자를 나열합니다.

```

Signed-off-by: flavono123 <flavono123@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants