Вклад в проект

Мы ценим ваш вклад! Поскольку это проект с открытым исходным кодом, мы хотим сделать процесс внесения изменений как можно более простым. Однако участникам необходимо следовать нескольким рекомендациям.

Стиль кодирования

Исходный код должен соответствовать стилю PEP8.

Другие требования к форматированию:

• отступ 4 пробела, табуляция не допускается;
• отсутствие пробелов в конце строки;
• все исходные файлы должны заканчиваться символом новой строки (пустая строка в конце);
• длина строк обычно не должна превышать 120 символов, хотя это не строгое правило.

Процесс

Создайте запрос на вытягивание (pull request) в GitHub со своим вкладом. Перед созданием запроса убедитесь, что все тесты пройдены. Мы также запускаем тесты на широком спектре плат для каждого запроса на вытягивание с помощью нашей настройки CI. Изменения должны пройти на всех протестированных платах, прежде чем запрос на вытягивание может быть объединён.

Руководство разработчика (developers_guide.md) описывает, как создать среду разработки. Руководство по автоматизированным тестам (automated_tests.md) содержит информацию о доступных типах тестов и описывает, как запускать тесты.

Дополнительная информация

Для получения дополнительной информации о внесении вклада см. документацию для участников Mbed OS (http://os.mbed.com/contributing). Хотя эта документация написана в первую очередь для Mbed OS, многое из неё применимо непосредственно к pyOCD.