Skip to content

Commit

Permalink
Created CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Created a quick guide for beginners
  • Loading branch information
mproshchuk authored Sep 14, 2024
1 parent b767164 commit afe401d
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Переклад документації
Для коректної роботи з перекладом необхідно докладно ознайомитися з [Керівництвом з розробки посібника з PHP](http://doc.php.net/tutorial/).

## Загальні тези
* Система контролю версій — Git, платформа — GitHub. Відповідно, щоб новачку якнайшвидше додати чи оновити файли, потрібно просто надіслати
_pull request_. Після певної кількості підтверджених _pull request_-ів перекладач отримує право на редагування сховища. Для цього він має
попросити про це команду документування.
* Документація ведеться в науковому стилі, файли документації написані мовою розмітки XML за певними правилами форматування.

## Додаткова інформація
Коли перекладач обрав файл, який необхідно перекласти, то на додаток до всіх приготувань, він змінює його статус на ***wip*** в тегові
*EN-Revision*,
```
<!-- EN-Revision: XXXXX Maintainer: YYYYY Status: wip -->
```
вивантажує цей файл в сховище і вже потім починає перекладати. WIP означає "**W**ork **i**n **p**rogress", тобто файл взятий в роботу. Це
робиться для того, щоб уникнути випадків, коли кілька перекладачів працюють над однаковим текстом.

Файл має містити тег *Reviewed*:
```
<!-- EN-Revision: XXXXX Maintainer: YYYYY Status: ready -->
<!-- Reviewed: no -->
```
Значення **no** ставлять, коли файл щойно перекладено.
Значення **yes** ставить інший перекладач після вичитки. Вичитку здійснює перекладач, що має право на редагування сховища.

### Словник термінів
> [!IMPORTANT]
> *Словник є неповним і недосконалим, тож вітається обговорення наявних та нових термінів. Українські відповідники, що **вже** викладені тут,
є обов'язковими до застосування з метою спільного трактування.*

| Англійською | Українською |
| - | - |
| argument | параметр |
| bootstrap file | файл ініціалізації |
| bug | вада |
| build | збірка, збирати |
| callable | назва виклику |
| conversion *(про тип)* | перетворення |
| cookies| куки |
| default | стандартний, початковий |
| debugger | зневаджувач/налагоджувач |
| engine | рушій |
| FAQ | ЧаПи (увага на регістри букв) |
| float | десятковий дріб/число з рухомою крапкою |
| folder | тека |
| handl(-e, -er) | дескриптор, обробник |
| hash | геш |
| implement *(про клас)* | реалізовувати |
| instance *(про клас)* | примірник |
| *(неіст.)* name | назва |
| named | названий |
| to sort | впорядковувати |
| source code | початковий код |
| rollback | відкочува(-ння/ти) |
| whitespace | пропуск |

### Обговорення можна проводити як тут, так і в списку розсилки [email protected]

0 comments on commit afe401d

Please sign in to comment.