Shared coding standards across projects

[theguild-bot]

This page is synced automatically from The Guild's Notion
Notion page URL: https://www.notion.so/Shared-coding-standards-across-projects-7994c67df4bd4e37a43eec8551697af2

General guidelines and goals

• Set of rules, standards, shared-eslint
• One source of truth for all configurations
• Dima: “Apply guild’s ESLint shareable config and apply separated PR with fixed”

Instructions, shared config and actual pipelines code is here: https://github.com/the-guild-org/shared-config/

Changesets

Things we want from changesets:

• Be on the adopters list
  • PR: https://github.com/changesets/changesets/pull/792
• I~~~~mprove reliability and reduce issues with NPM publish command, and have better support for projects with many packages.
  • https://github.com/dotansimha/graphql-yoga/blob/master/patches/%40changesets%2Bcli%2B2.22.0.patch#L10
  • Big repos tends to run a lot of npm commands, and the default limit is 40, which leads to a lot of rate-limit errors.
  • PR to fix that: https://github.com/changesets/changesets/pull/853
• More flexibility over how peerDependencies are being upgraded.
  • Reference:
    • chore: patch changeset for better peerDependency behaviour dotansimha/graphql-yoga#1034
    • chore: patch changesets for treating peer dependencies different  n1ru4l/envelop#1288
    • Fix peer dep changelogs changesets/changesets#747 (comment)
    • THIS IS NOW ALSO A PROPOSED ISSUE 🥳 Make peerDependencies release type match dependant package or configurable changesets/changesets#827
• Easy support for alpha/canary releases based on Git (today we do this with patches)
  • PR: https://github.com/changesets/changesets/issues/855
  • https://github.com/dotansimha/graphql-yoga/blob/master/patches/%40changesets%2Bassemble-release-plan%2B5.1.2.patch
• Support for automatic changesets for Renovate PRs (so dependencies upgrade will also be documented well in CHANGELOGs)
• Make GitHub release page aggregate multiple releases to make it more readable
  • PR to add support for this feature: https://github.com/changesets/action/pull/193
  • Related: https://github.com/changesets/changesets/issues/320
  • Related: https://github.com/changesets/changesets/issues/683
  • Might be related: https://github.com/changesets/changesets/issues/655
  • https://tortilla-hq.slack.com/archives/CAYJ1G1DY/p1654581149381409
    • @dotansimha : this is actually not the issue, we need to modify the changesets GH Action code, to support a mode where we publish a single GH Release per Changesets PR.
• https://github.com/the-guild-org/external-board-tasks/issues/92
• Benchmarking: shared setup
  • Maybe let’s add our k6 setup to all relevant repositories?
  • What if we store historical data in CloudFlare KV and adjust the threshold dynamically?
  • We could take it to next level and display charts (perf over time) in some dashboard
  • All of that could be an alternative to K6 Cloud and used in other open-source projects on GitHub
• https://github.com/the-guild-org/external-board-tasks/issues/85
• LICENSE file should be included in the published npm packages ardatan/graphql-tools#4627

GitHub Actions

• https://github.com/the-guild-org/shared-config/
• https://github.com/the-guild-org/changesets-snapshot-action
• https://github.com/the-guild-org/changesets-dependencies-action
• Ideas:
  • Prettier Bot
    Often a PR is blocked by prettier (e.g. if it is a documentation only update). In that case we need to ping the PR creator or checkout the PR manually. Instead we could have a bot that runs prettier and creates PR suggestions. This could be done either automatically or via a command @the-guild-bot format (https://tortilla-hq.slack.com/archives/C03B470CJCT/p1660649548686799)
  • Shared pipelines for common tasks (serial or parallel)
  • Use GitHub Check Suite reports for ESLint

Typescript

• Use https://github.com/tsconfig/bases across our libraries

Memory leaks

• https://tortilla-hq.slack.com/archives/CAYJ1G1DY/p1660055076768669

Repositories

| Name        | Step 10 | Step 11 |   |
| ----------- | ------- | ------- | - |
| Yoga        | ✅       | ✅       |   |
| Envelop     |         |         |   |
| Mesh        | ✅       | ✅       |   |
| Modules     | ✅       | ✅       |   |
| Scalars     | ✅       | ✅       |   |
| Codegen     | ✅       | ✅       |   |
| Tools       |         |         |   |
| ESLint      | ✅       | ✅       |   |
| Config      | ✅       | ✅       |   |
| whatwg-node | ✅       | ✅       |   |
| CLI         |         |         |   |
| Hive        |         |         |   |