Спецификация
Ниже приведён пример использования таблицы вклада всех участников
Обязательно
Чтобы поддержать спецификацию All Contributors проекты с открытым исходным кодом должны включать в себя приведённые ниже обязательные пункты:
- Раздел "Участники" на видном месте в документации репозитория проекта, который включает список всех участников проекта
- Цель должна заключаться в использовании, по возможности, наиболее заметного места проектной документации. Во многих случаях это файл README
- Consider using a CONTRIBUTORS file in the top level of the repository when the number of project contributors exceeds a level at which it is unfeasible to use the README file to acknowledge contributions. В таком случае, на странице README должна быть заметная ссылка на файл CONTRIBUTORS под заголовком "Участники"
- Список должен быть отформатирован в виде таблицы со следующей информацией об участниках проекта:
- Имя
- Ссылка на сайт, где можно узнать об участнике подробнее. This URL may be determined by the contributor at the project's discretion.
- Обозначение категории вклада в виде текста или иконки, использя установлнные категории вклада и/или эмодзи категории вклада (см. ниже).
- Сссылка на категорию вклада в виде текста или эмодзи, используся установленные категории вклада и/или эмодзи категорий вклада.
- По необходимости, список участников может занимать несколько строк (каждая из которых технически является отдельной таблицей).
- Порядок участников в списке не имеет значения для спецификации. Упорядочивайте их так как захотите.
- Проекты должны определять участников как тех, кто участвует в проекте в любой из категорий вклада на любом уровне участия. Эта спецификация, по определению, включает в себя любое участие в проекте. В случае если проекты отступают от категорий вклада или требуют определённого уровня участия для того чтобы соответствовать критериям участника проекта, проект должен предоставить подробную документацию в файле CONTRIBUTING или в похожем видимом публичном документе в верхнем уровне репозитория, который содержит в себе определения этих критериев. Эта спецификация рекомендует не исключать лиц из списка участников основываясь на представлениях об уровне вклада. Вместо этого, проекты должны использовать показатели достижений внутри списка, который продолжает включать в себя всех участников проекта независимо от уровня вклада. В случае использования показателей достижений, они определяются на усмотрение проекта и на данный момент не установлены данной спецификацией.
Подсказка: Вы можете использовать the @all-contributors bot 🤖 для автоматического внесения участников в ваш проект ✨
Опционально
Проекты должны учитывать следующие необязательные пункты в знак приверженности спецификации All Contributors:
- Рекомендуется включить аватар пользователя.
- Можно добавить необязательные ссылки из индикаторов категорий вклада на вклад(ы) определённых категорий, чтобы предоставить дополнительную информацию о вкладе(ах) в проект, о чём подробно говорится в разделе ниже.