Skip to content

Commit

Permalink
docs: add hints for v1 source preference over v0 in contrib guide
Browse files Browse the repository at this point in the history
  • Loading branch information
gitcommitshow authored Nov 29, 2024
1 parent 36a0c74 commit 90a86d5
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ Follow through the next sections to learn about developing a new **source integr

* [Overview of integration development journey](#overview-of-integration-development-journey)
* [1. Setup rudder-transformer and understand the code structure](#1-setup-rudder-transformer-and-understand-the-code-structure)
* [2. Write code for a v0 source integration](#2-write-code-for-a-v0-source-integration)
* [3. Test your v0 source integration](#3-test-your-v0-source-integration)
* [2. Write code for a source integration](#2-write-code-for-a-source-integration)
* [3. Test your source integration](#3-test-your-source-integration)
* [4. Write automated tests](#4-write-automated-tests)
* [5. Add RudderStack UI configurations in integrations-config](#5-add-rudderstack-ui-configurations-in-integrations-config)
* [6. Run the transformer locally](#6-run-the-transformer-locally)
Expand Down Expand Up @@ -109,13 +109,11 @@ Understand the code structure
* `test/integrations/destinations` - Integration tests for destination integrations


### 2. Write code for a v0 source integration
### 2. Write code for a source integration

Here, we will explain the code for a v0 source integration but most of the learning will apply to other integrations as well (destination and v1).
Note: Here, we are using an example of `v0` source integration, so you might see some mentions of the `src/v0` folder. But we recommend to use `src/v1` folder for new source integrations.



* Create a new directory with the integration name under `src/v0` (follow the snake case naming convention)
* Create a new directory with the integration name under `src/v1/sources` (follow the snake case naming convention)
* Add `transform.js`, add a `process(eventData)` function and export it. This is the function which will be called to transform the event data received from the source
* Add `config.js` to separate the source configuration and mapping

Expand Down Expand Up @@ -202,7 +200,7 @@ function process(eventPayload) {
exports.process = process;
```
### 3. Test your v0 source integration
### 3. Test your source integration
#### Manual testing
Expand Down

0 comments on commit 90a86d5

Please sign in to comment.