Основы для запуска руководства по вкладу проекта с открытым исходным кодом

Question

Я планирую начать проект с открытым исходным кодом

в настоящее время на стадии планирования

Я завершил работу над технологическим стеком, и в основном это будет узел в серверной части и инфраструктура JS SPA во внешнем интерфейсе.

В настоящее время я документирую рекомендации по вкладам.

Я хочу, чтобы проект прошел строгую модульную проверку, а код должен соответствовать руководству по стилю Airbnb JS

какие методологии я должен внедрить, чтобы заставить каждого участника соответствовать требованиям

ссылки на любой подобный проект или любые инструменты / библиотеки будут полезны

Answer 1

Я не эксперт по техническим возможностям здесь, поэтому ответ, который фокусируется на мягких аспектах здесь: прежде всего, посмотрите на свое собственное отношение. Если вы действительно думаете, что хотите навязать что-то людям, которых вы просите поработать с вами над проектом, вы (в определенной степени) уже идете по неверной кроличьей норе.

Мое предложение: сфокусируйтесь на четком описании и документировании ваших ожиданий. Укажите всем будущим участникам, какой вклад следует предоставить. И будьте готовы привести пример. Убедитесь, что все, что вы добавляете в проект, на 100% соответствует этим целям по качеству, форме, контенту, который вы изначально выложили. И с этого момента: будьте готовы к рассмотрению чужого вклада. Инструменты типа "ворс" могут быть в состоянии отследить нарушения правил, но даже красиво отформатированный код может быть "не чистым", не читаемым, не обслуживаемым.

Таким образом, будьте готовы потратить значительное количество времени на проверку кода - стараясь поощрять позитивное поведение и давать полезные, конструктивные предложения для ввода, который не соответствует вашим стандартам.