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/ko: Translate uftrace-script.md in Korean #1966

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

CTRLHyeon
Copy link

@CTRLHyeon CTRLHyeon commented Sep 9, 2024

Add --no-args option, which is present in the English
uftrace-script.md but not in the Korean uftrace-script.md,
and fix some translations

@gichoel
Copy link
Contributor

gichoel commented Sep 9, 2024

First of all, thank you for contributing to improving the Korean documentation of uftrace.

However, I think there are a few things that need to be fixed in this PR, and they are as follows:

  1. Please add : after doc/ko in the commit title.
    We need a delimiter to separate the title and the type.

  2. Please be more specific in the commit description.
    One of the rules for writing a good commit message is to describe what you changed and why you changed it. This way, other people can know what you changed without having to check the code directly using only the git log command.

If you need examples of writing commit messages, see c454d1e, db895cc, d69b471.

Finally, if you run into any problems while making changes or don't know what to do, leave a comment and we'll try to help :)

@CTRLHyeon CTRLHyeon changed the title doc/ko Translate uftrace-script.md in Korean doc/ko: Translate uftrace-script.md in Korean Sep 9, 2024
@CTRLHyeon
Copy link
Author

Thanks for advice. I edited thing you taught. Please review it again.

@gichoel
Copy link
Contributor

gichoel commented Sep 9, 2024

First of all, I think you should remove line numbers from commits, because if other contributors contribute to the documentation later, the line numbers will change, making it impossible to compare.

Also, I would like the body to be different from the title, with a little more description of what was done and why, like the commit I attached as an example.

Here's what I thought the commit message would look like.

doc/ko: Translate uftrace-script.md in Korean

Add `--no-args` option, which is present in the English
`uftrace-script.md` but not in the Korean `uftrace-script.md`, 
and fix some translations.

But I'm not sure about this, so We'll wait for an admin to review it :)

@CTRLHyeon
Copy link
Author

I appreciate for your kind answer. I never thought about further contributes. I pondered your advises and thought it would be better to edit as you told me. your answers helped and taught me a lot. Thank you!

Add `--no-args` option, which is present in the English
`uftrace-script.md` but not in the Korean `uftrace-script.md`,
and fix some translations

Signed-off-by: JoJeongHyeon <qmzp124816@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.

2 participants