Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (47 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

79 lines (47 loc) · 2.22 KB
Raw

Contributing to Raygun4Node

Project and library organisation

Building the project requires Node.js.

The project should work on all LTS Node versions.

  • The raygun package is at the repository root.
  • The examples folder contains example apps showing the provider capabilities.

Building and running

The recommended IDE for working on this project is Visual Studio Code.

Tests

To run tests, run npm run test or run all tests from VSCode.

To test the actual examples against a local mock Raygun endpoint, run these commands from the repository root (Node.js 20 or later):

npm run prepare
npm --prefix examples/express-sample ci --ignore-scripts
npm --prefix examples/using-domains ci --ignore-scripts
npm run test:examples

These tests use a test API key and do not contact Raygun. Set RAYGUN_TEST_EXAMPLE=express-sample or RAYGUN_TEST_EXAMPLE=using-domains to run only one example.

Code analysis

To check the code, run npm run eslint and npm run tseslint.

Formatting

To format the code, run npm run prettier.

Running examples

Instructions on how to run the examples can be found in the examples folder.

How to contribute?

This section is intended for external contributors not part of the Raygun team.

Before you undertake any work, please create a ticket with your proposal, so that it can be coordinated with what we're doing.

If you're interested in contributing on a regular basis, please get in touch with the Raygun team.

Fork the repository

Please fork the main repository from https://github.com/MindscapeHQ/raygun4node into your own GitHub account.

Create a new branch

Create a local branch off develop in your fork, named so that it explains the work in the branch.

Do not submit a PR directly from your develop branch.

Open a pull request

Submit a pull request against the main repositories' develop branch.

Fill the PR template and give it a title that follows the Conventional Commits guidelines.

Wait for a review

Wait for a review by the Raygun team. The team will leave you feedback and might ask you to do changes in your code.

Once the PR is approved, the team will merge it.