search

web-standards-ru / podcast-old

Выпуски подкаста «Веб-стандарты»
Other
233 stars 22 forks source link

CONTRIBUTING.md #21

Closed firefoxic closed 8 years ago

firefoxic commented 8 years ago

Сами бурные обсуждения в слаке наталкивали на мысль, которая сформировалась в момент решения завершить обсуждение там.

Тогда я взял всю переписку нашу, и стал обрабатывать. В итоге получился такой вот гайдик по расшифровке. Заодно шаблон дополнил разными примерами тех рекомендаций, что есть в гайде.

Предлагаю всем обсудить, надо оно или нет. И если надо, то что и как исправить.

pepelsbey commented 8 years ago

Идея хорошая, но я бы сделал немного иначе:

  1. Меньше фантазировал в типовом выпуске, ведь именно его я использую, когда пишу заметки к свежему выпуску.
  2. Не создавал лишних файлов и описал бы всё в ридми, указав примеры там: это ссылка, это код, это примечение. Так гораздо понятнее и не нужно читать длинный фантазийный текст. Даже больше, ведь есть специальный CONTRIBUTING.md, который как раз описывает правила участия, туда всё, а в ридми приглашение и основы.
firefoxic commented 8 years ago

Про шаблон не знал, учту. А отдельный файл — так это пока. Я вообще не уверен был, что нужно это всё. Вернее, что примется. Это всего лишь слегка обработанная переписка в слаке. Причём некоторые моменты вроде простые, а обсуждались по 10 раза. Поэтому и захотелось гайд и для уже набирающих, и тем более для новых желающих помочь. Совсем не хочется каждому что-то объяснять, или поправлять. Например про хоткеи в плеере, оказалось что это не такое очевидное дело. Поэтому и объяснение этого момента перенёс сюда из слаки. Хочется в дальнейшем просто дать ссыль человеку. Он почитает, и уже сможет приняться за работу.

firefoxic commented 8 years ago

Понравился этот контрибьютинг. Думаю возьму его за основу наверно. Особенно автоматическое закрытие ишьи при мерже пр. Ну и нейминг веткок — тоже разумно, чтоб самому же не запутаться в них. Но так же кратко не получится всяко :) учитывая что примеры ещё приписать придётся.

firefoxic commented 8 years ago

Пока до такого варианта сократил. Но есть несколько предложений по ишьям и пулл-реквестам.

firefoxic commented 8 years ago

Третья редакция готова. Пока я даже не знаю, что ещё можно сделать с этим.

pepelsbey commented 8 years ago

Вместо дальнейшего обсуждения я бы вмёржил и переработал. Займусь сегодня.