Примечание от переводчика
Здесь содержится перевод файла contributing.md. Если при нажатии на ссылку, содержащую последние правки в master ветке AVA, Вы не можете найти файл contributing.md, то можете считать что перевод актуален.
✨ Благодарим за содействие к AVA! ✨
Пожалуйста обратите внимание, что этот проект выпущен с Кодексом Поведения участника. Участвуя в этом проекте, Вы соглашаетесь с этими условиями.
Переводы: Español, Français, Italiano, 日本語, Português
Как пользователь AVA - Вы отлично подходите для помощи с улучшением документации. Исправить опечатки, поправить ошибки, улучшить объяснение, добавить новые примеры и т.д. Откройте вопрос для обсуждения вещей, которые могут быть улучшены. Помогите перевести документацию. Все что угодно. Даже улучшить этот документ.
Некоторые созданные вопросы в трекере имеют недостающую информацию, не могут быть легко воспроизведены или просто некорректны. Помогите нам решить их. Обработка вопросов в трекере занимает много времени, которое лучше потратить на исправление ошибок или добавление новых возможностей.
Мы всегда рады новым точкам зрения в наших дискуссиях в трекере вопросов. Это хорошая возможность оказать влияние на будущее AVA.
У нас есть чат. Присоединяйтесь, общайтесь и помогайте другим.
- У нас есть трекер вопросов. Используйте наш чат или Stack Overflow для поддержки.
- Поищите интересующий Вас вопрос в трекере, перед тем, как открыть новый.
- Удостоверьтесь, что Вы используете последнюю версию AVA.
- Используйте понятный и информативный заголовок.
- Добавьте максимум необходимой информации: шаги для воспроизводства проблемы, сообщения об ошибке, версия Node.js, операционная система и т.д.
- Чем больше внимания Вы уделите проблеме, тем больше времени мы потратим на нее.
- Лучший запрос о проблеме - это тест, подтверждающий ее.
- Чаще сложные изменения необходимо сперва обсудить, чтобы предотвратить ненужную работу.
- Для абмициозных идей, Вы должны как можно скорее получить обратную связь от сообщества. Откройте запрос на изменения как только у Вас будет минимальный функционал демонстрирующий Вашу идею. В этот момент не беспокойтесь о том, чтобы все работало идеально и на 100%. Добавьте [WIP] префикс в заголовок и напишите, что еще необходимо сделать. Это позволит тем, кто будет проверять код, не придираться к мелочам о которых Вам уже известно.
- Добавление новых возможностей должно сопровождаться документацией и тестами.
- Не включайте изменения, не относящиеся к делу.
- Используйте Lint и тесты перед отправкой Ваших изменений выполнив
$ npm test. - Отправляйте Ваши изменения из отдельной ветки, не из master.
- Используйте простой и информативный заголовок в Ваших коммитах и отправке правок.
- Напишите убедительное описание, почему мы должны одобрить Ваши правки. Это Ваша работа убедить нас. Напишите почему правки необходимы и примеры использования.
- Вас могут попросить сделать изменения в Ваш запрос. Не нужно открывать новый запрос изменений. Просто обновите текущий.