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

Мы будем рады, если вы поможете нам улучшить этот проект. Чтобы помочь нам поддерживать высокое качество коллекции, мы просим, чтобы вклад соответствовал следующим рекомендациям:

• Предоставьте ссылку на домашнюю страницу приложения или проекта. Если это не очень популярный проект, есть вероятность, что разработчики не знают о языке, фреймворке, редакторе, приложении или проекте, к которому относится ваше изменение.

• Предоставьте ссылки на документацию, подтверждающую вносимое вами изменение. Лучше всего подойдёт актуальная каноническая документация, в которой упоминаются игнорируемые файлы. Если документации для подтверждения вашего изменения нет, постарайтесь объяснить, для чего нужны игнорируемые файлы.

• Объясните, почему вы вносите изменение. Даже если это кажется очевидным, пожалуйста, напишите одно-два предложения, объясняющие, почему должно произойти ваше изменение или дополнение. Особенно полезно сформулировать, почему это изменение применимо ко всем, кто работает с соответствующей технологией, а не только к вам или вашей команде.

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

• Изменяйте только один шаблон на один запрос на включение изменений (pull request). Это поможет сделать запросы и обратную связь более сфокусированными на конкретном проекте или технологии.

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

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