goldbergyoni / goldbergyoni/javascript-testing-best-practices
Suggestion of some little markup rules for deep conformity in the context of languages
- Dominant language
- JavaScript
- Stars
- 24.6k
- Forks
- 2.1k
- PR merge metrics
- No merged PRs in 30d
Description
Hi! I'm an amateur translator. I love markdown. I also like the count lines of any translated documents to match. Ever.
I would like to suggest some guidelines to improve our markdown translation practice. Related #161
1. Do not break the paragraph on a new line. All lines are endless. Line length is endless. This means that a thought within a paragraph will always be within a paragraph. It is enough for us to know its line number.
1. Do not add more than one blank line. There may be a blank line between paragraphs. This is normal and often convenient. Many blank lines confuse the translator. Sometimes the thought is created that something is lost here.
1. Try to use punctuation that are appropriate for your language. It helps others understand you in the final language. For example in my language almost no apostles or single quotation marks are used.
1. Use a linter on your side. There are many linters we cannot synchronize them all. I'm using [markdownlint](https://github.com/DavidAnson/markdownlint). I just add `.markdownlint.json` to `.git/info/exclude`
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.