UNPKG

dd-trace-api

Version:

An API for dd-trace, the Datadog APM library for Node.js.

45 lines (24 loc) • 3.42 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# Welcome Welcome! We are glad you are interested in contributing to dd-trace-js. This guide will help you understand the requirements and guidelines to improve your contributor experience. ## Contributing to code ### New features If you want to contribute with a new feature, before start writing any code, you will need to get your proposal accepted by the maintainers. This is to avoid going through the effort of writing the code and getting it rejected because it is already being worked on in a different way, or it is outside the scope of the project. Open a new issue with the title "[RFC] Title of your proposal". In the description explain carefully why you think this feature is needed, why it is useful, and how you plan to implement it. During the RFC process, your change proposal, alongside with implementation approaches, will get discussed with the maintainers, ensuring that you don’t waste time with wrong approaches or features that are out of scope for the project. If, after the discussion, the proposal gets rejected, the team will give you an explanation and close the issue. ### Bug fixes If you have identified an issue that is already labeled as `bug` that hasn’t been assigned to anyone, feel free to claim it, and ask a maintainer to add you as assignee. Once you have some code ready, open a PR, [linking it to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar). Take into account that if the changes to fix the bug are not trivial, you need to follow the RFC process as well to discuss the options with the maintainers. ### Setting up your development environment This is a Node.js project, therefore you'll need Node.js installed. While many versions of Node.js are supported, we always recommend development on the latest version of Node.js. Once you have Node.js and npm installed, you can `npm install` to install dependencies. ### Testing your changes `npm test` will run the test suite. ## Contributing to issues ### Contributing to reporting bugs If you think you have found a bug in dd-trace-js feel free to report it. When creating issues, you will be presented with a template to fill. Please, fill as much as you can from that template, including steps to reproduce your issue, so we can address it quicker. ### Contributing to triaging issues Triaging issues is a great way to contribute to an open source project. Some actions you can perform on an open by someone else issue that will help addressing it sooner: - Trying to reproduce the issue. If you can reproduce the issue following the steps the reporter provided, add a comment specifying that you could reproduce the issue. - Finding duplicates. If there is a bug, there might be a chance that it was already reported in a different issue. If you find an already reported issue that is the same one as the one you are triaging, add a comment with "Duplicate of" followed by the issue number of the original one. - Asking the reporter for more information if needed. Sometimes the reporter of an issue doesn’t include enough information to work on the fix, i.e. lack of steps to reproduce, not specifying the affected version, etc. If you find a bug that doesn’t have enough information, add a comment tagging the reporter asking for the missing information.