goldbergyoni / goldbergyoni/javascript-testing-best-practices
Suggestion of some little markup rules for deep conformity in the context of languages
- Lingua principale
- JavaScript
- Stelle
- 24.6k
- Fork
- 2.1k
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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`
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Direzione di ricerca
Esamina prima le linee guida proposte per la traduzione di Markdown e la discussione correlata #161. Verifica se i maintainer hanno scelto una convenzione per le interruzioni di paragrafo, le righe vuote, la punteggiatura e il linting. Il lavoro è completato quando si è raggiunto un accordo sull'ambito e si è documentata una pratica di traduzione accettata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- markdown
- Ambito
- documentation, localization
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100