Skip to content

👷 Updating contribution guidelines #3607

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.

Sign up for GitHub

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

👷 Updating contribution guidelines #3607

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b795a80
docs: update contributing guide
mormubis Jun 6, 2025
989b925
fix: remove duplicated sentence
mormubis Jun 6, 2025
1c4d17e
fix: format
mormubis Jun 6, 2025
3f13e93
docs: alternative to local dev
mormubis Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,46 @@ First of all, thanks for contributing!
This document provides some basic guidelines for contributing to this repository. To propose
improvements, feel free to submit a pull request.

## Getting Started

### Download the Repository

You can use either Git or GitHub CLI:

```bash
# Using Git
git clone [email protected]:DataDog/browser-sdk.git

# Using GitHub CLI
gh repo clone DataDog/browser-sdk
```

## Install Dependencies

Run the following command to install the necessary dependencies:

```bash
yarn
```

## Install Browser Extension

Follow [this link][3] to download the browser extension. This extension will help you track
all the information collected by the SDK.

## Running the Project

To run the project, use:

```bash
yarn dev
```

Then, go to [http://localhost:8080/react-app/](http://localhost:8080/react-app/). Open the developer
tools and navigate to the `Browser SDK` tab to view all the information sent by the SDK.

Alternatively, you can debug your application by using the option to override the SDK within your application.

## Submitting issues

Github issues are welcome, feel free to submit error reports and feature requests! Make sure to add
Expand Down Expand Up @@ -65,3 +105,4 @@ label our Commit messages and Pull Request titles:

[1]: https://docs.datadoghq.com/help/
[2]: https://gitmoji.carloscuesta.me/
[3]: https://chromewebstore.google.com/detail/datadog-browser-sdk-devel/boceobohkgenpcpogecpjlnmnfbdigda