Skip to content

Commit 35525cb

Browse files
committed
fix repo link
1 parent 09f76e4 commit 35525cb

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

packages/profiling-node/CONTRIBUTING.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,33 @@
66

77
# Contributing
88

9-
We welcome suggested improvements and bug fixes to the `@sentry/*` family of packages, in the form of pull requests on [`GitHub`](https://github.com/getsentry/profiling-node). The guide below will help you get started, but if you have further questions, please feel free to reach out on [Discord](https://discord.gg/Ww9hbqr).
9+
We welcome suggested improvements and bug fixes to the `@sentry/*` family of packages, in the form of pull requests on
10+
[`GitHub`](https://github.com/getsentry/sentry-javascript). The guide below will help you get started, but if you have
11+
further questions, please feel free to reach out on [Discord](https://discord.gg/Ww9hbqr).
1012

1113
## Setting up an Environment
1214

1315
To run the test suite and our code linter, node.js and npm are required.
1416

1517
[`npm and node` download](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
1618

17-
Because the repository requires you to compile the c++ bindings via node-gyp, we may require you to install dependencies like Python and GCC. See [node-gyp](https://github.com/nodejs/node-gyp#on-unix) for a full list of those requirements depending on the OS that you are running.
19+
Because the repository requires you to compile the c++ bindings via node-gyp, we may require you to install dependencies
20+
like Python and GCC. See [node-gyp](https://github.com/nodejs/node-gyp#on-unix) for a full list of those requirements
21+
depending on the OS that you are running.
1822

1923
## Building the package
2024

21-
Since we are using [`TypeScript`](https://www.typescriptlang.org/) and native node addons, you need to transpile the code to JavaScript and compile the c++ bindings in order to be able to run the addon.
25+
Since we are using [`TypeScript`](https://www.typescriptlang.org/) and native node addons, you need to transpile the
26+
code to JavaScript and compile the c++ bindings in order to be able to run the addon.
2227

2328
- `yarn build` will compile the c++ bindings and ts files.
2429
- `yarn build:lib` will compile ts files
2530
- `yarn build:bindings` will compile c++ bindings
2631

2732
## Tests
2833

29-
Tests are colocated with source files and should have a .test.ts suffix. The entire test suite can be ran using the `yarn test` command.
34+
Tests are colocated with source files and should have a .test.ts suffix. The entire test suite can be ran using the
35+
`yarn test` command.
3036

3137
## Linting
3238

@@ -37,12 +43,17 @@ Similar to building and testing, linting can be done via `yarn lint` command.
3743
When contributing to the codebase, please note:
3844

3945
- Non-trivial PRs will not be accepted without tests (see above).
40-
- We encourage you to open issues and discuss the change you want to make before opening PR's. This is especially true if you are considering adding new functionality. Remember that your requirements may differ from the direction that we want this SDK to take.
46+
- We encourage you to open issues and discuss the change you want to make before opening PR's. This is especially true
47+
if you are considering adding new functionality. Remember that your requirements may differ from the direction that we
48+
want this SDK to take.
4149
- Please do not bump version numbers yourself.
4250

4351
## Benchmarks
4452

45-
The repository contains micro benchmarks. You can find all benchmarks at the benchmarks folder in project root directory. The benchmarks can either be ran directly through node via `node benchmarks/cpu/benchmark.profiler.js` or via `yarn benchmark` command. There are also individual yarn benchmark commands like `yarn benchmark:server` or `yarn benchmark:methods` which will only run individual benchmarks.
53+
The repository contains micro benchmarks. You can find all benchmarks at the benchmarks folder in project root
54+
directory. The benchmarks can either be ran directly through node via `node benchmarks/cpu/benchmark.profiler.js` or via
55+
`yarn benchmark` command. There are also individual yarn benchmark commands like `yarn benchmark:server` or
56+
`yarn benchmark:methods` which will only run individual benchmarks.
4657

4758
Remember that these are micro benchmarks and that results will vary across different OS and architectures.
4859

@@ -51,7 +62,9 @@ Remember that these are micro benchmarks and that results will vary across diffe
5162
_These steps are only relevant to Sentry employees when preparing and publishing a new SDK release._
5263

5364
1. Determine what version will be released (we use [semver](https://semver.org)).
54-
2. Update [`CHANGELOG.md`](https://github.com/getsentry/profiling-node/edit/master/CHANGELOG.md) to add an entry for the next release number and a list of changes since the last release. (See details below.)
55-
3. Run the [Prepare Release](https://github.com/getsentry/profiling-node/actions/workflows/release.yml) workflow.
65+
2. Update [`CHANGELOG.md`](https://github.com/getsentry/sentry-javascript/edit/master/CHANGELOG.md) to add an entry for
66+
the next release number and a list of changes since the last release. (See details below.)
67+
3. Run the [Prepare Release](https://github.com/getsentry/sentry-javascript/actions/workflows/release.yml) workflow.
5668
4. A new issue should appear in https://github.com/getsentry/publish/issues.
57-
5. Ask a member of the [@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve the release.
69+
5. Ask a member of the [@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve
70+
the release.

0 commit comments

Comments
 (0)