This repository was archived by the owner on Jan 8, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 3 files changed +61
-117
lines changed Expand file tree Collapse file tree 3 files changed +61
-117
lines changed Original file line number Diff line number Diff line change
1
+ <p align =" center " >
2
+ <a href =" https://sentry.io " target =" _blank " align =" center " >
3
+ <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
4
+ </a >
5
+ <br />
6
+ </p >
7
+
8
+ # Contributing
9
+
10
+ This part of the documentation gives you a basic overview of how to help with the development of our ` @sentry/* `
11
+ packages contained in this repo.
12
+
13
+ ## Setting up an Environment
14
+
15
+ To run the test suite and run our code linter, node.js and yarn are required.
16
+
17
+ [ ` node ` ] ( https://nodejs.org/download ) [ ` yarn ` ] ( https://yarnpkg.com/en/docs/install )
18
+
19
+ Since this is a mono repo containing several packages, we use ` lerna ` to manage them.
20
+
21
+ To get started call:
22
+
23
+ ```
24
+ $ yarn
25
+ ```
26
+
27
+ After that you need to setup the workspace with:
28
+
29
+ ```
30
+ $ yarn lerna bootstrap
31
+ ```
32
+
33
+ With that, the repo is fully setup and you are ready to run all commands.
34
+
35
+ ## Build
36
+
37
+ Since we are using [ ` TypeScript ` ] ( https://www.typescriptlang.org/ ) you need to transpile the code to JavaScript to be
38
+ able to use it. Every package has a ` build ` script which takes care of everything. You can also run ` build ` on every
39
+ package by calling
40
+
41
+ ```
42
+ $ yarn build
43
+ ```
44
+
45
+ in the project root.
46
+
47
+ ## Running the Test Suite
48
+
49
+ You can run all test at once by calling ` yarn test ` in the project root or in individual sub packages.
50
+
51
+ ## Lint
52
+
53
+ You can run all test at once by calling ` yarn lint ` in the project root or in individual sub packages.
54
+
55
+ ## Contributing Back Code
56
+
57
+ Please, send over suggestions and bug fixes in the form of pull requests on
58
+ [ ` TypeScript ` ] ( https://github.com/getsentry/sentry-javascript ) . Any nontrivial fixes/features should include tests. Do
59
+ not bump version numbers yourself. For new features and improvements consider contributing to our new SDKs instead,
60
+ ` raven-js ` and ` raven-node ` will still be supported but are in maintenance mode and will only receive bug fixes.
Original file line number Diff line number Diff line change @@ -15,6 +15,7 @@ backwards compatibility from time to time.
15
15
16
16
## Contents
17
17
18
+ - [ Contributing] ( https://github.com/getsentry/sentry-javascript/blob/master/README.md )
18
19
- [ Supported Platforms] ( #supported-platforms )
19
20
- [ Installation and Usage] ( #installation-and-usage )
20
21
- [ Other Packages] ( #other-packages )
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments