CONTRIB-233: Setup AllContributors (part 1/3) #363

azinit · 2021-11-17T08:22:22Z

DISCLAIMER

Это только первая итерация, чтобы дифф не разрастался

Общий план работ можно глянуть по задаче #233

🤷‍♂️

CHANGELOG

chore(promo): Засетапил .all-contributors
chore(promo): Добавил пока только кортиму и экс-кортимовцев, т.к. дифф итак немаленький выходит
- Хочу по итогу прийти к тому, как у chakra-ui
- У них там еще all-members подключен в помощь
- UPD: Ну и да, все генерится из ваших гх профайлов 🤷‍♂️

Чеклист

Если при работе с документацией потребовалось использовать github-дискуссии, то стоит их прикрепить как see-also источники
Если PR связан с задачей, то необходимо проверить, что все требования по задаче выполнены
Перед тем, как отправлять изменения на ревью, нужно ознакомиться с CONTIBUTING-гайдлайнами
Перед тем, как отправлять изменения на ревью, нужно провести self-review своих изменений
Перед тем, как отправлять изменения на ревью, нужно дождаться CI-проверок
Перед тем, как отправлять изменения на ревью, нужно дать краткое описание изменений

…, upd: azinit)

…, upd:others)

azinit

Изменений вродь немного, но расписал все спорные моменты)

Ориентировался при разработке на:
https://github.com/codesandbox/codesandbox-client#contributors-
https://github.com/effector/effector#contributors-
https://github.com/chakra-ui/chakra-ui#contributors-

azinit · 2021-11-17T17:03:14Z

README.md

+    <td align="center"><a href="https://github.com/ilyaagarkov"><img src="https://avatars.githubusercontent.com/u/10822601?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ilya</b></sub></a><br /><a href="https://github.com/feature-sliced/documentation/commits?author=ilyaagarkov" title="Documentation">📖</a> <a href="#ideas-ilyaagarkov" title="Ideas, Planning, & Feedback">🤔</a> <a href="#talk-ilyaagarkov" title="Talks">📢</a> <a href="#maintenance-ilyaagarkov" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://start.reactwarriors.com/join"><img src="https://avatars.githubusercontent.com/u/15031623?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Evgeniy Podgaetskiy</b></sub></a><br /><a href="#ideas-epodgaetskiy" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-epodgaetskiy" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://binjo.ru/"><img src="https://avatars.githubusercontent.com/u/8722478?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Viktor Pasynok</b></sub></a><br /><a href="https://github.com/feature-sliced/documentation/commits?author=binjospookie" title="Documentation">📖</a> <a href="#ideas-binjospookie" title="Ideas, Planning, & Feedback">🤔</a> <a href="#projectManagement-binjospookie" title="Project Management">📆</a> <a href="#talk-binjospookie" title="Talks">📢</a></td>
+    <td align="center"><a href="https://github.com/OlegBrony"><img src="https://avatars.githubusercontent.com/u/19880334?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Oleh</b></sub></a><br /><a href="https://github.com/feature-sliced/documentation/commits?author=OlegBrony" title="Documentation">📖</a> <a href="#ideas-OlegBrony" title="Ideas, Planning, & Feedback">🤔</a> <a href="#tutorial-OlegBrony" title="Tutorials">✅</a></td>


Все что тут - это лишь "авторендерилка" конфига, что упомянут выше

Опять же, можно задать куда рендерить список контрибьюторов, но оставил в ридми, как по дефолту

+ оставил также, чтобы внизу страницы рендерилось, т.к. хз как это переопределить)
В доке не нашел

https://allcontributors.org/docs/en/cli/configuration

azinit · 2021-11-17T17:04:32Z

.all-contributorsrc

+      "contributions": [
+        "blog",
+        "doc",
+        "example",
+        "ideas",
+        "projectManagement",
+        "question",
+        "infra",
+        "research",
+        "eventOrganizing",
+        "tutorial",
+        "talk",
+        "maintenance"
+      ]


Здесь и далее отметил не просто "текущий статус достижений", но и весь список былых заслуг

Чтобы не просто была "актуализируемая борда" а прям "доска почета"

Повторюсь, конкретных контрибьюторов (как минимум @Postamentovich @GhostMayor ) добавим следующим PR, чтобы этот не засорялся

При этом есть очевидные проблемы, которые пока хз как покрыть:

Есть ряд людей, которые в конкретных аспектах проявили себя больше других

@AlexandrHoroshih как ТОП-ревьювер,

@sergeysova - как создатель и созидатель этого всего в течение долгого времени

и т.п.

Обычными эмодзи этого не добьешься, поэтому тут нужно как будто кастомный бейджик в темплейт добавлять

Также, т.к. шаблон автогенерится, то сложно поддерживать ссылки в актуальном состоянии
(как это советует делать allcontributors)

Ну и да, про типы контрибьюшны можно тут глянуть
https://allcontributors.org/docs/en/emoji-key

azinit · 2021-11-17T17:13:14Z

.all-contributorsrc

    {
      "login": "azinit",
      "name": "Ilya Azin",
      "avatar_url": "https://avatars.githubusercontent.com/u/42924400?v=4",
      "profile": "https://t.me/ilya_azin",
      "contributions": [
-        "code"
+        "doc",


Опять же, если кажется, что кого-то "обделил" регалиями, то дайте знать)

@sergeysova @AlexandrHoroshih @KaraMokusee @unordinarity @spotsccc @ilyaagarkov

azinit · 2021-11-17T17:14:24Z

.all-contributorsrc

  "projectName": "documentation",
  "projectOwner": "feature-sliced",
  "repoType": "github",
  "repoHost": "https://github.com",
-  "skipCi": true
+  "skipCi": true,
+  "commitConvention": "none"


Конвенция по коммитам - тоже автоматически определилась
Прям как-то явно прописывать, что conventionalcomments, учитывая что ее в списке нет - пока не вижу смысл, т.к. нигде это не отображается 🤔

Но мб заблуждаюсь, дайте знать
https://allcontributors.org/docs/en/cli/configuration

azinit · 2021-11-17T17:17:23Z

README.md

Тут на самом деле даже хз, что за дифф, но это стандартный темплейт 🤔

azinit · 2021-11-17T17:17:34Z

README.md

@@ -1,6 +1,6 @@
 # feature-sliced
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)


Бейджик тоже автоматом обновляется

azinit · 2021-11-17T17:18:02Z

website/package.json

+        "contributors:add": "cd .. && all-contributors add",
+        "contributors:generate": "cd .. && all-contributors generate"


Временный хак, т.к. конфиг контрибьюторов и package.json находятся на разных уровнях вложенности

Будет пофикшено вместе с #319

Команды добавил , так же, как и у codesandbox

https://github.com/codesandbox/codesandbox-client/blob/cfba0db370d2b0252f39ca077a91cc56f6d2f54d/package.json#L52

azinit · 2021-11-17T17:23:08Z

website/package.json

@@ -53,6 +55,7 @@
        "@eslint-kit/eslint-config-patch": "^1.0.0",
        "@eslint-kit/eslint-config-prettier": "3.0.0",
        "@eslint-kit/eslint-config-react": "^3.0.0",
+        "all-contributors-cli": "^6.20.0",


Ну тут понятно)

https://allcontributors.org/docs/en/cli/installation

azinit · 2021-11-17T17:23:31Z

website/yarn.lock

+"@babel/runtime@^7.14.6", "@babel/runtime@^7.7.6":
+  version "7.16.3"
+  resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.16.3.tgz#b86f0db02a04187a3c17caa77de69840165d42d5"
+  integrity sha512-WBwekcqacdY2e9AF/Q7WLFUWmdJGJTkbjqTjoMDgXkVZ3ZRUvOPsLb5KdwISoQVsbP+DQzVZW4Zhci0DvpbNTQ==
+  dependencies:
+    regenerator-runtime "^0.13.4"
+


Ну и жирнющий дифф)

azinit added 14 commits November 17, 2021 10:21

CONTRIB-233: @chore(all-contributors): install all-contributors-cli

362e399

CONTRIB-233: @chore(all-contributors): setup scripts

e489d74

Merge branch 'master' into chore/CONTRIB-233-init-all-contributors

45f13de

CONTRIB-233: @chore(all-contributors): setup scripts (temp fix)

1d08b0c

CONTRIB-233: @chore(all-contributors): setup CoreTeam (azinit)

0a5315c

CONTRIB-233: @chore(all-contributors): setup CoreTeam (add:sergeysova…

3aceaea

…, upd: azinit)

CONTRIB-233: @chore(all-contributors): setup CoreTeam (add:KaraJovian…

c3f7ccf

…, upd:others)

CONTRIB-233: @chore(all-contributors): setup CoreTeam (unordinarity)

a7fb53c

CONTRIB-233: @chore(all-contributors): setup CoreTeam (AlexandrHoroshih)

c22fa23

CONTRIB-233: @chore(all-contributors): setup CoreTeam (add translation)

d732557

CONTRIB-233: @chore(all-contributors): setup CoreTeam (spotsccc)

8cd95b5

CONTRIB-233: @chore(all-contributors): setup CoreTeam (ilyaagarkov)

d9a9401

CONTRIB-233: @chore(all-contributors): setup CoreTeam (epodgaetskiy)

bbe2f3a

CONTRIB-233: @chore(all-contributors): limit contributors per line

cdc1375

azinit marked this pull request as draft November 17, 2021 08:22

azinit added 3 commits November 17, 2021 19:28

CONTRIB-233: @chore(all-contributors): actualize CoreTeam contributions

b7018d9

CONTRIB-233: @chore(all-contributors): actualize CoreTeam contributions

0704d05

CONTRIB-233: @chore(all-contributors): add ext CoreTeam members

c0a4fc2

azinit changed the title ~~CONTRIB-233: Setup AllContributors~~ CONTRIB-233: Setup AllContributors (part 1/3) Nov 17, 2021

azinit commented Nov 17, 2021

View reviewed changes

azinit marked this pull request as ready for review November 17, 2021 17:24

azinit requested review from AlexandrHoroshih, GhostMayor and Postamentovich November 17, 2021 17:25

azinit mentioned this pull request Nov 17, 2021

CONTRIB: Setup AllContributors #233

Closed

15 tasks

azinit requested review from spotsccc and unordinarity November 17, 2021 17:26

Postamentovich approved these changes Nov 17, 2021

View reviewed changes

AlexandrHoroshih approved these changes Nov 17, 2021

View reviewed changes

azinit merged commit c5419c0 into master Nov 17, 2021

azinit deleted the chore/CONTRIB-233-init-all-contributors branch November 17, 2021 21:29

azinit linked an issue Nov 18, 2021 that may be closed by this pull request

CONTRIB: Setup AllContributors #233

Closed

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CONTRIB-233: Setup AllContributors (part 1/3) #363

CONTRIB-233: Setup AllContributors (part 1/3) #363

azinit commented Nov 17, 2021 •

edited

Loading

azinit left a comment

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

azinit Nov 17, 2021

		"contributors:add": "cd .. && all-contributors add",
		"contributors:generate": "cd .. && all-contributors generate"

CONTRIB-233: Setup AllContributors (part 1/3) #363

CONTRIB-233: Setup AllContributors (part 1/3) #363

Conversation

azinit commented Nov 17, 2021 • edited Loading

DISCLAIMER

CHANGELOG

Чеклист

azinit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azinit commented Nov 17, 2021 •

edited

Loading