-
Notifications
You must be signed in to change notification settings - Fork 765
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Translate bug_report.md via GitLocalize * Translate CHANGELOG.md via GitLocalize * Translate CHANGELOG.md via GitLocalize * Translate CODEBASE_STRUCTURE.md via GitLocalize * Translate CODEBASE_STRUCTURE.md via GitLocalize * Translate CODE_OF_CONDUCT.md via GitLocalize * Translate CODE_OF_CONDUCT.md via GitLocalize * Translate CODING_GUIDELINES.md via GitLocalize * Translate TODO.md via GitLocalize * Translate PULL_REQUEST_TEMPLATE.md via GitLocalize * Translate CONTRIBUTING.md via GitLocalize * Translate Hackathon.md via GitLocalize * Translate Hackathon.md via GitLocalize * Translate Bot.md via GitLocalize * Translate Bot.md via GitLocalize * Translate Minimal.md via GitLocalize * Translate Minimal.md via GitLocalize * Translate Standard.md via GitLocalize * Translate Standard.md via GitLocalize * Translate feature_request.md via GitLocalize * Translate custom.md via GitLocalize * Update CONTRIBUTING.md * Update custom.md * Update bug_report.md * Update feature_request.md * Update Minimal.md * Update Standard.md Co-authored-by: mt-gitlocalize <[email protected]>
- Loading branch information
1 parent
ac9d363
commit e0e1163
Showing
14 changed files
with
666 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Изменения | ||
|
||
Все заметные изменения в этом проекте будут записаны в этом файле. | ||
|
||
Формат основан на [Как логировать изменения](http://keepachangelog.com/) и этот проект придерживается [семантического управления версиями](http://semver.org/). | ||
|
||
## [Неизданные] - гггг-мм-дд | ||
|
||
Здесь мы пишем заметки об обновлениях для брендов. Это командное усилие, чтобы сделать их как можно более простыми. | ||
|
||
### Добавили | ||
|
||
- [ИМЯПРОЕКТА-XXXX ](http://tickets.projectname.com/browse/PROJECTNAME-XXXX) НЕЗНАЧИТЕЛЬНОЕ Здесь должно быть название задачи. | ||
- [ИМЯПРОЕКТА-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY) ИСПРАВЛЕНИЕ Здесь должно быть название задачи. | ||
|
||
### Изменили | ||
|
||
### Исправили | ||
|
||
## [1.2.4] - 15.03.2017 | ||
|
||
Шаги по обновлениям в 1.2.4, которым люди должны следовать. | ||
|
||
### Добавили | ||
|
||
### Изменили | ||
|
||
- [ИМЯПРОЕКТА-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ) ИСПРАВЛЕНИЕ Drupal.org теперь используется для компоновщика. | ||
|
||
### Исправили | ||
|
||
- [ИМЯПРОЕКТА-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT) ИСПРАВИЛИ Добавили логику к удалению тизера рабочего листа, чтобы удалить соответствующие карточки расписания. | ||
|
||
## [1.2.3] - 14.03.2017 | ||
|
||
### Добавили | ||
|
||
### Изменили | ||
|
||
### Исправили | ||
|
||
- [ИМЯПРОЕКТА-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU) НЕЗНАЧИТЕЛЬНОЕ Исправлен модуль foo tests. | ||
- [ИМЯПРОЕКТА-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR) ВАЖНОЕ Модуль Foo использует часовой пояс браузера для выбора даты. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
Это каталоги, которые мы активно используем в разработке: | ||
|
||
- [frontend/server/controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers): Контроллеры выполняют бизнес-логику и предоставляют серверный API. | ||
- [frontend/server/libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Библиотеки и утилиты. | ||
- [frontend/server/libs/dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Data Access Objects [DAO] и Value Objects [VO]. Классы, используемые для представления схем базы данных и облегчения их использования контроллерами. | ||
- [frontend/templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): Шаблоны Smarty для создания HTML-кода, который отображается пользователям. | ||
- [frontend/www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): Полное содержание Интернет-страницы. | ||
|
||
### Фронтенд / www | ||
|
||
Содержание: | ||
|
||
- js / | ||
- css / | ||
|
||
#### js | ||
|
||
Как следует из названия, здесь находятся все шрифты javascript и фреймворки javascript. Если вы хотите внести изменения, уменьшите javascript, а затем загрузите. | ||
|
||
#### css | ||
|
||
Как и в случае с js, тут уменьшенные файлы css. | ||
|
||
### Фронтенд / сервер | ||
|
||
Содержание: | ||
|
||
- dao / | ||
- контроллеры / | ||
|
||
Ни один из этих модулей не должен быть доступен внешнему миру. Единственное, что может их вызвать — это пользовательский интерфейс. Вот почему они находятся в папке www. | ||
|
||
#### DAO / VO | ||
|
||
Папка *dao* содержит классы для уровня доступа к данным. Он должен знать 2 вещи: *data access objects* и *value objects*. *Value objects*(VO) — это не что иное, как классы, которые сопоставляются непосредственно с каждой таблицей в базе данных. Поэтому там есть как класс под названием Users, так и таблица с тем же именем. Этот класс имеет свои сеттеры и геттеры для каждого поля в базе данных. * Data access objects*(dao) — являются статическими классами для каждой из таблиц, они служат для получения и создания постоянных объектов *vo*. | ||
|
||
[Вот больше информации об этой модели](http://www.ibm.com/developerworks/java/library/j-dao/) | ||
|
||
#### Контроллеры | ||
|
||
Контроллеры — это то место, где принимаются решения. Контроллер использует dao и vo для принятия решений и никогда не вызывает базу данных напрямую. Таким образом, мы избегаем использования отдельных контроллеров для каждого модуля проекта. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Кодекс поведения участников Соглашения | ||
|
||
## Наше обещание | ||
|
||
В интересах создания открытой и доброжелательной среды мы, как участники и сопровождающие, обязуемся сделать участие в нашем проекте и нашем сообществе свободным от преследований для всех, независимо от возраста, размера тела, инвалидности, этнической принадлежности, половых характеристик, гендерной идентичности, самовыражение, уровеня опыта, образования, социально-экономического статус, национальности, внешнего вида, расы, религии или сексуальной идентичности и ориентации. | ||
|
||
## Наши стандарты | ||
|
||
Примеры поведения, которое способствует созданию благоприятной среды, включают: | ||
|
||
- Использование приветливого и инклюзивного языка | ||
- Уважительное отношение к различным точкам зрения и опыту | ||
- Изящно принимаю конструктивную критику | ||
- Сосредоточение внимания на том, что лучше для сообщества | ||
- Проявление сочувствия к другим членам сообщества | ||
|
||
Примеры недопустимого поведения участников включают: | ||
|
||
- Использование сексуализированной лексики или образов и нежелательное сексуальное внимание или заигрывания | ||
- Троллинг, оскорбительные / уничижительные комментарии, а также личные или политические нападки | ||
- Публичное или частное преследование | ||
- Публикация частной информации других лиц, такой как физический или электронный адрес, без явного разрешения | ||
- Другое поведение, которое можно обоснованно считать неуместным в профессиональной среде. | ||
|
||
## Наши обязанности | ||
|
||
Сопровождающие проекта несут ответственность за разъяснение стандартов приемлемого поведения и от них ожидают принятия соответствующих и справедливых корректирующих действий в ответ на любые случаи неприемлемого поведения. | ||
|
||
Сопровождающие проекта имеют право и обязаны удалять, редактировать или отклонять комментарии, коммиты, код, правки вики, проблемы и другие материалы, которые не соответствуют настоящему Кодексу поведения, или временно или навсегда заблокировать любого участника за другое поведение, которое они считают неуместным, угрожающим, оскорбительным или вредным. | ||
|
||
## Сфера | ||
|
||
Этот Кодекс поведения применяется как в проектных, так и в общественных местах, когда человек представляет проект или его сообщество. Примеры представления проекта или сообщества включают использование официального адреса электронной почты проекта, размещение сообщений через официальную учетную запись в социальных сетях или выполнение функций назначенного представителя на онлайн- или офлайн-мероприятии. Представление проекта может быть дополнительно определено и уточнено сопровождающими проекта. | ||
|
||
## Исполнение | ||
|
||
О случаях оскорбления, преследования или иного недопустимого поведения можно сообщить, связавшись с командой проекта по адресу [email protected]. Все жалобы будут рассмотрены и исследованы, и в результате будет дан ответ, который будет сочтен необходимым и соответствующим обстоятельствам. Команда проекта обязана сохранять конфиденциальность в отношении лица, сообщившего об инциденте. Более подробная информация о конкретных правилах применения может быть опубликована отдельно. | ||
|
||
Сопровождающие проекта, которые не соблюдают и не соблюдают Кодекс поведения добросовестно, могут столкнуться с временными или постоянными последствиями, как это определено другими членами руководства проекта. | ||
|
||
## Атрибуция | ||
|
||
Этот Кодекс поведения адаптирован из [Соглашения для авторов], версия 1.4, доступного по адресу https://www.contributor-covenant.org/version/1/4/code-of-conduct.html. | ||
|
||
Ответы на распространенные вопросы об этом кодексе поведения см. https://www.contributor-covenant.org/faq. | ||
|
||
|
||
[Соглашения для авторов]: https://www.contributor-covenant.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Гайдлайн по написанию кода | ||
|
||
- Вы можете проверить, соответствует ли ваш код этому гайдлайну, запустив `stuff/php-format.py validate` | ||
- Табуляция, без пробелов | ||
- Конец строки должен быть в стиле Unix (`\n`), а не в стиле Windows (`\r\n`) | ||
- Открывающие скобки находятся в той же строке, что и последний оператор. | ||
|
||
``` | ||
if (condition) { | ||
stuff; | ||
} | ||
``` | ||
|
||
- Пробел между ключевыми словами и круглыми скобками для: `if`, `else`, `while`, `switch`, `catch`, `function` | ||
- В вызовах функций нет пробела перед круглыми скобками | ||
- В скобках нет пробелов | ||
- Пробел после каждой запятой, но без пробела перед | ||
- Все бинарные операторы должны иметь один пробел до и один после | ||
- Не должно быть более одной непрерывной пустой строки | ||
- Пустых комментариев быть не должно | ||
- Вы не должны использовать блоки комментариев `/ * ... * /`, только строку `// ...` | ||
- Изменения в функциональности должны сопровождаться соответствующими новыми/ модифицированными тестами | ||
- Исключения должны использоваться для сообщения об ошибочных состояниях. Использование функций, возвращающих true/false, разрешено, когда они являются ожидаемыми значениями | ||
- При необходимости используйте [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization), в основном при администрировании ресурсов (файлов и т. д.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Руководство по участию | ||
|
||
- Пополнить The Documentation Compendium довольно просто. В этом документе показано, как начать работу | ||
|
||
## Общее | ||
|
||
- [Структура кодовой базы ](./CODEBASE_STRUCTURE.md) содержит подробную информацию о том, как структурированы различные файлы в этом проекте | ||
- Пожалуйста, убедитесь, что любые внесенные вами изменения соответствуют [Гайдлайну по написанию кода](./CODING_GUIDELINES.md) этого репозитория | ||
|
||
## Отправка изменений | ||
|
||
- Сделайте форк репозитория | ||
- [https://github.com/kylelobo/The-Documentation-Compendium/fork](https://github.com/kylelobo/The-Documentation-Compendium/fork) | ||
- Проверьте новую ветку и назовите ее в соответствии с тем, что вы собираетесь делать: | ||
- Пример: | ||
``` | ||
$ git checkout -b BRANCH_NAME | ||
``` | ||
Если вы получите сообщение об ошибке, вам может потребоваться сначала получить fooBar, используя | ||
``` | ||
$ git remote update && git fetch | ||
``` | ||
- Используйте одну ветку для каждого исправления / добавления | ||
- Закоммитьте свои изменения | ||
- Пожалуйста, предоставьте git сообщение, объясняющее, что вы сделали | ||
- Пожалуйста, убедитесь, что ваши коммиты соответствуют [соглашениям](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md) | ||
- Закоммите в репозитории | ||
- Пример: | ||
``` | ||
$ git commit -am 'Add some fooBar' | ||
``` | ||
- Запуште в ветку | ||
- Пример: | ||
``` | ||
$ git push origin BRANCH_NAME | ||
``` | ||
- Сделать пул реквест | ||
- Убедитесь, что вы отправили пул реквест в ветку <code>fooBar</code> | ||
- Travis CI наблюдает за тобой! | ||
Если вы будете следовать этим инструкциям, ваш пул реквест довольно безопасно попадет в основной репозиторий! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
Имя: Отчет об ошибке | ||
О чем: Создайте отчет, который поможет нам стать лучше | ||
Заголовок: | ||
Лэйблы: | ||
Исполнители: | ||
--- | ||
|
||
**Опишите ошибку** Четкое и краткое описание ошибки. | ||
|
||
**Как воспроизвести** Шаги для воспроизведения: | ||
|
||
1. Перейдите к '...' | ||
2. Нажмите на '....' | ||
3. Прокрутите вниз до "...." | ||
4. Увидите ошибку | ||
|
||
**Ожидаемое поведение** Четкое и краткое описание того, что вы ожидали. | ||
|
||
**Скриншоты** Если возможно, добавьте скриншоты, которые помогут объяснить вашу проблему. | ||
|
||
**<strong>Компьютер (заполните следующую информацию):</strong>** | ||
|
||
- ОС: [например, iOS] | ||
- Браузер [например, Chrome, Safari] | ||
- Версия [например, 22] | ||
|
||
**<strong>Смартфон (заполните следующую информацию):</strong>** | ||
|
||
- Устройство: [например, iPhone6] | ||
- ОС: [например, iOS8.1] | ||
- Браузер [например, стандартный браузер, Safari] | ||
- Версия [например, 22] | ||
|
||
**Дополнительный контекст** Добавьте сюда дополнительную информацию о проблеме. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
Имя: Шаблон задачи | ||
О чем: Опишите здесь цель этого шаблона задачи. | ||
Заголовок: | ||
Лэйблы: | ||
Исполнители: | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
Имя: Предложение | ||
О чем: Предложите идею для этого проекта | ||
Заголовок: | ||
Лэйблы: | ||
Исполнители: | ||
--- | ||
|
||
**Связано ли ваше предложение с проблемой? Пожалуйста, опишите.** Четкое и краткое описание проблемы. Пример: Я всегда расстраиваюсь, когда [...] | ||
|
||
**Ожидаемое поведение** Четкое и краткое описание того, что вы ожидали. | ||
|
||
**Опишите альтернативы, которые вы рассмотрели.** Четкое и краткое описание любых альтернативных решений или возможностей, которые вы рассмотрели. | ||
|
||
**Дополнительный контекст** Добавьте сюда любой другой контекст или скриншоты. |
Oops, something went wrong.