Skip to content

CONTRIBUTING-ru.md

Latest commit

 

History

History
105 lines (90 loc) · 12.3 KB

CONTRIBUTING-ru.md

File metadata and controls

105 lines (90 loc) · 12.3 KB

🤝 Вклад в NeoBleeper

Прежде всего, спасибо, что рассматриваете возможность внести свой вклад в NeoBleeper! Ваш вклад — неотъемлемая часть успеха этого проекта. Сообщаете ли вы об ошибке, предлагаете новую функцию, улучшаете документацию, загружаете ли устаревшие файлы BMM или NBPML или отправляете код, ваше участие будет высоко оценено.

📑 Содержание

  1. Кодекс поведения
  2. Как я могу внести свой вклад?
  3. Процесс запроса на включение изменений
  4. Руководства по стилю
  5. Сообщество Поддержка

🌟 Кодекс поведения

Участвуя в этом проекте, вы соглашаетесь соблюдать Кодекс поведения. Пожалуйста, будьте уважительны и внимательны к другим участникам сообщества. Подробнее см. файл CODE_OF_CONDUCT-ru.md.

🤝🙋‍♂️ Как я могу внести свой вклад?

🪲 Отчёты об ошибках

Если вы нашли ошибку в NeoBleeper, пожалуйста, создайте сообщение об ошибке и укажите следующую информацию: - Чёткое и понятное название. - Версию NeoBleeper или хэш коммита, если применимо. - Действия по воспроизведению проблемы или фрагмент кода. - Ожидаемое и фактическое поведение. - Любые другие важные сведения, включая скриншоты или журналы сбоев.

💭 Запросы на новые функции

Мы будем рады вашим идеям! Чтобы запросить функцию:

  1. Проверьте запросы, чтобы убедиться, что кто-то уже запросил её.
  2. Если нет, создайте новый запрос и опишите его подробно, включая:
    • Предысторию запроса.
    • Почему он ценен.
    • Возможные последствия, риски или замечания.

👩‍💻 Внесение изменений в код

  1. Создайте форк репозитория и новую ветку от main. Назовите ветку описательным именем, например, feature/add-tune-filter.
  2. Откройте папку репозитория в Visual Studio:
    • Убедитесь, что у вас установлена ​​Visual Studio с необходимыми рабочими нагрузками (например, «.NET desktop development» для NeoBleeper).
    • Клонируйте форк репозитория на локальный компьютер (можно использовать встроенные в Visual Studio инструменты Git или Git CLI). - После клонирования откройте файл решения (.sln) в Visual Studio.
  3. Установите пакеты NuGet:
    • Восстановите все необходимые зависимости, нажав «Восстановить пакеты NuGet» на верхней панели или выполнив команду dotnet restore в терминале.
  4. Внесите изменения:
    • Используйте такие функции Visual Studio, как IntelliSense, отладка и форматирование кода, для эффективного внесения изменений.
    • Убедитесь, что включены необходимые тесты, и все существующие тесты пройдены.
    • Убедитесь, что ваш код соответствует руководству по стилю.
  5. Добавьте своё имя или псевдоним на страницу «О проекте»:
    • Откройте файл about_neobleeper.cs и найдите компонент listView1.
    • Выберите компонент listView1 в конструкторе Visual Studio.
    • Щёлкните по небольшой стрелке в правом верхнем углу компонента, чтобы открыть раскрывающееся меню.
    • Выберите Изменить элементы, чтобы открыть редактор коллекции элементов ListView. – Добавьте новый ListViewItem: – Введите своё имя или псевдоним в свойство Text. – Для ваших вкладов/задач: – Найдите свойство SubItems. – Щёлкните по трём точкам (...) справа от поля (Collection). – Добавьте или отредактируйте SubItem, кратко описав свои задачи. – Если вы уже добавили своё имя, отредактируйте SubItem или обновите существующую запись перед фиксацией изменений.
  6. Протестируйте свой код: – Запустите тесты с помощью обозревателя тестов Visual Studio. – Исправьте все не пройденные тесты и проверьте свои изменения.
  7. Зафиксируйте свои изменения с чёткими и лаконичными сообщениями. – Используйте встроенные в Visual Studio инструменты Git для подготовки и фиксации своих изменений.
  8. Отправьте свою ветку на сервер и откройте запрос на извлечение в репозитории.
  9. Будьте готовы работать с рецензентами и вносить необходимые изменения.

🧾 Документация

Улучшение нашей документации — один из самых простых способов внести свой вклад! Не стесняйтесь добавлять или обновлять примеры, уточнять разделы или улучшать общую читаемость.

🎼 Внесение изменений в файлы BMM и NBPML

NeoBleeper поддерживает устаревшие файлы BMM (Bleeper Music Maker) и NBPML (NeoBleeper Project Markup Language). Если вы вносите изменения или работаете с этими типами файлов, убедитесь, что:

  • Убедитесь, что файлы BMM корректно обрабатываются и отображаются в NeoBleeper.
  • Проверьте совместимость как с устаревшими форматами, так и с текущей реализацией.
  • Для файлов NBPML соблюдайте последние спецификации языка разметки проектов NeoBleeper.

Если у вас возникнут какие-либо проблемы, связанные с этими форматами файлов, пожалуйста, следуйте инструкциям в разделе «Отчёты об ошибках». Мы также приветствуем запросы на расширенную поддержку файлов BMM и NBPML!

⬇️ Процесс запроса на включение изменений

Все заявки должны быть поданы через запросы на включение изменений. Вот процесс:

  1. Заполните шаблон запроса на включение изменений.
  2. Убедитесь, что ваш запрос на включение изменений не дублирует существующие.
  3. Добавьте подробную информацию о ваших изменениях в описание, по возможности ссылаясь на связанные проблемы.
  4. Учитывайте все комментарии или запрошенные изменения от рецензентов.
  5. Запросы на включение изменений должны проходить все проверки непрерывной интеграции и непрерывной поставки (CI/CD), включая тестирование и проверку качества кода.

📖 Руководства по стилю

✨ Стиль кода

Следуйте Соглашениям о кодировании .NET. Ключевые моменты:

  • Отдавайте предпочтение автоматическим свойствам вместо публичных полей.
  • Используйте var для локальных переменных, если их тип очевиден.
  • Избегайте «магических» строк и чисел. Используйте константы или перечисления.

📒 Замечания, касающиеся C#

  • Размещайте { на той же строке, что и предыдущий код.
  • Используйте PascalCase для имён классов и методов, а также camelCase для локальных переменных.
  • Следуйте Руководству по именованию Microsoft.

👨‍👩‍👧‍👦 Поддержка сообщества

По любым вопросам обращайтесь в GitHub или через раздел «Trukes». Мы призываем всех делиться знаниями и помогать коллегам.

Спасибо за ваш вклад в NeoBleeper и помощь в создании чего-то невероятного!