Skip to content

Commit 5b4d97a

Browse files
committed
readme
1 parent 1816af9 commit 5b4d97a

File tree

1 file changed

+45
-7
lines changed

1 file changed

+45
-7
lines changed

README.md

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,28 @@
22

33
This repository hosts the translation of <https://javascript.info> in Spanish.
44

5-
Please help us to make the translation better.
5+
6+
**That's how you can contribute:**
67

78
- See the [Spanish Translate Progress](https://github.com/javascript-tutorial/es.javascript.info/issues/17) issue.
89
- Choose an unchecked article you'd like to translate.
9-
- Add a comment to that issue to inform the maintainer that you're translating it.
10+
- Add a comment with the article title to the issue, e.g. `An Introduction to JavaScript`.
11+
- Our bot will mark it in the issue, for everyone to know that you're translating it.
12+
- Your comment should contain only the title.
1013
- Fork the repository, translate and send a PR when done.
14+
- PR title should match article title, the bot will write it's number into the issue.
15+
16+
Please kindly allow maintainers to review and merge or request changes in your translation.
17+
18+
If maintainers do not respond, or if you'd like to become a maintainer, write us at the [main repo](https://github.com/javascript-tutorial/en.javascript.info/issues/new).
19+
20+
**Let others know what you're translating, in message boards or chats in your language. Invite them to join!**
1121

1222
🎉 Thank you!
1323

1424
Your name and the contribution size will appear in the "About project" page when the translation gets published.
1525

16-
P.S. The full list of languages can be found at <https://github.com/javascript-tutorial/translate>.
26+
P.S. The full list of languages can be found at <https://javascript.info/translate>.
1727

1828
## Structure
1929

@@ -33,10 +43,16 @@ Additional resources and examples for the article or the task, are also in the s
3343

3444
## Translation Tips
3545

36-
The translation doesn't have to be word-by-word precise. It should be technically correct and explain well.
46+
Please keep line breaks and paragraphs "as is": don't add newlines and don't remove existing ones. Makes it easy to merge future changes from the English version into the translation.
3747

3848
If you see that the English version can be improved – great, please send a PR to it.
3949

50+
### Terms
51+
52+
- Some specification terms are not to be translated, e.g. "Function Declaration" can be left "as is".
53+
- For other terms like `resolved promise`, `slash`, `regexp`, and so on look a good glossary, hopefully there's one for your language already.
54+
- If there's no dictionary, look for translations in manuals, such as [MDN](https://developer.mozilla.org/en-US/).
55+
4056
### Text in Code Blocks
4157

4258
- Translate comments.
@@ -86,13 +102,35 @@ Example:
86102
[JavaScript](https://es.wikipedia.org/wiki/JavaScript) es un lenguaje de programación.
87103
```
88104

89-
For links to MDN, that are only partially translated, also use the language-specific version.
105+
For links to MDN, a partially translated version is ok.
90106

91107
If a linked article has no translated version, leave the link "as is".
92108

109+
### Metadata
110+
111+
Some files, usually tasks, have YAML metadata at the top, delimited by `---`:
112+
113+
```md
114+
importance: 5
115+
116+
---
117+
...
118+
```
119+
120+
Please don't translate "importance" (and other top metadata).
121+
122+
### Anchors
123+
124+
Some headers have `[#anchor]` at the end, e.g.
125+
126+
```md
127+
## Spread operator [#spread-operator]
128+
```
129+
130+
Please don't translate or remove the `[#...]` part, it's for URL anchors.
93131

94132
## Running locally
95133

96-
You can run the tutorial locally, to immediately see the changes on-site.
134+
You can run the tutorial server locally to see how the translation looks.
97135

98-
The server is at <https://github.com/javascript-tutorial/server>.
136+
The server and install instructions are at <https://github.com/javascript-tutorial/server>.

0 commit comments

Comments
 (0)