Contributing ru

English · 简体中文 · 繁體中文 · Español · العربية · Français · Português (Brasil) · Deutsch · हिन्दी · 日本語 · 한국어 · Русский · Bahasa Indonesia · Türkçe · Italiano · Tiếng Việt

Участие в разработке docxi

Мы рады сообщениям об ошибках, исправлениям, документации и переводам. На этой странице описано, как сообщить о проблеме и что нужно для pull request. Как подготовить рабочую копию, описано в разделе Среда разработки.

Как сообщить об ошибке

Создайте issue на github.com/hammad417/docxi/issues и укажите:

• короткий скрипт на Ruby, который воспроизводит проблему
• версии Ruby, docxi, nokogiri и rubyzip (и Rails, если вы его используете)
• что вы ожидали и что получили. Если документ испорчен, укажите, в какой программе вы его открывали

О проблемах безопасности сообщайте не публично. См. Безопасность.

Pull request

1. Сделайте форк репозитория и создайте ветку.
2. Внесите изменения в стиле окружающего кода.
3. Добавьте или обновите тесты и выполните bundle exec rake test.
4. Если создаваемый XML меняется намеренно, выполните bundle exec rake golden и объясните изменение в pull request. Эталонные файлы защищают результат, на который полагаются нынешние пользователи.
5. Обновите CHANGELOG.md и документацию, если меняется поведение.
6. Откройте pull request. CI запускает тесты на Ruby от 2.5 до 4.0 и Rails от 5.2 до 8.1 и проверяет, что LibreOffice открывает примеры документов.

Изменения, которые меняют существующие документы, например исправления, запланированные на 0.2.0, нужно отправлять отдельным pull request, чтобы разницу в эталонных файлах было легко проверить.

Документация и переводы

• Английский README служит источником для 15 переводов в docs/i18n/. Меняя его, следуйте docs/i18n/TRANSLATION_GUIDE.md в репозитории.
• Эта вики пишется в папке wiki/ репозитория и публикуется оттуда. Порядок описан в wiki/README.md.

Связанные страницы

• Среда разработки
• Архитектура
• Планы

---

← Главная вики · README