Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add some clarity in CONTRIBUTING.md #4850

Merged
merged 1 commit into from
Nov 1, 2024
Merged

Conversation

bengl
Copy link
Collaborator

@bengl bengl commented Oct 31, 2024

What does this PR do?

  • Rather than sending users down the painful path of running yarn services without setting env vars, and bringing up all the docker containers, it now directs folks to only bring up the images and install the packages for plugins they're actually working on.
  • Recommends using the latest Node.js version.
  • Provides instructions for installing yarn.
  • Clarifies that yarn lint does other things too.

Motivation

It's hard to get started with this repo.

@bengl bengl requested a review from a team as a code owner October 31, 2024 18:42
Copy link

Overall package size

Self size: 7.86 MB
Deduped: 64.88 MB
No deduping: 65.22 MB

Dependency sizes | name | version | self size | total size | |------|---------|-----------|------------| | @datadog/native-appsec | 8.2.1 | 19.18 MB | 19.19 MB | | @datadog/native-iast-taint-tracking | 3.2.0 | 13.9 MB | 13.91 MB | | @datadog/pprof | 5.4.1 | 9.76 MB | 10.13 MB | | protobufjs | 7.2.5 | 2.77 MB | 5.16 MB | | @datadog/native-iast-rewriter | 2.5.0 | 2.51 MB | 2.65 MB | | @opentelemetry/core | 1.14.0 | 872.87 kB | 1.47 MB | | @datadog/native-metrics | 3.0.1 | 1.06 MB | 1.46 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | import-in-the-middle | 1.11.2 | 112.74 kB | 826.22 kB | | msgpack-lite | 0.1.26 | 201.16 kB | 281.59 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | lru-cache | 7.18.3 | 133.92 kB | 133.92 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.0 | 109.9 kB | 109.9 kB | | semver | 7.6.3 | 95.82 kB | 95.82 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 5.3.1 | 51.46 kB | 51.46 kB | | int64-buffer | 0.1.10 | 49.18 kB | 49.18 kB | | shell-quote | 1.8.1 | 44.96 kB | 44.96 kB | | istanbul-lib-coverage | 3.2.0 | 29.34 kB | 29.34 kB | | rfdc | 1.3.1 | 25.21 kB | 25.21 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | dc-polyfill | 0.1.4 | 23.1 kB | 23.1 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB | | crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | path-to-regexp | 0.1.10 | 6.38 kB | 6.38 kB | | module-details-from-path | 1.0.3 | 4.47 kB | 4.47 kB |

🤖 This report was automatically generated by heaviest-objects-in-the-universe

@pr-commenter
Copy link

pr-commenter bot commented Oct 31, 2024

Benchmarks

Benchmark execution time: 2024-10-31 18:47:20

Comparing candidate commit ef863db in PR branch bengl/contrib-updates-2024-10-31 with baseline commit 4edba95 in branch master.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 259 metrics, 7 unstable metrics.


To install dependencies once you have Node and yarn installed, run:
```sh
$ npm install -g yarn
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought these days you should just run corepack enable? But maybe my knowledge is outdated

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That depends on specifying "packageManager" in package.json, which we haven't done yet. We could do that, or recommend a corepack install, but npm works just fine to install yarn 1.x across our entire supported version range (early 16.x releases didn't have corepack).

@bengl bengl merged commit 1188ea2 into master Nov 1, 2024
206 of 207 checks passed
@bengl bengl deleted the bengl/contrib-updates-2024-10-31 branch November 1, 2024 18:08
rochdev pushed a commit that referenced this pull request Nov 6, 2024
rochdev pushed a commit that referenced this pull request Nov 6, 2024
rochdev pushed a commit that referenced this pull request Nov 6, 2024
rochdev pushed a commit that referenced this pull request Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants