Thanks for taking the time and for your help in improving this project!
To contribute to this project, we need you to sign the Contributor License Agreement (“CLA”) for the first commit you make. By agreeing to the CLA, we can add you to list of approved contributors and review the changes proposed by you.
To contribute a destination, you need to provide all the required data for all the fields you want as the settings to configure the destination.
You can checkout the sample input file here:
For the above input data, the UI will look like as shown below:
In the input file, you need to provide the destination name you want to display in the UI in the displayName field.
Each json object inside the formFields represents a field you want to add as a connection/configuration settings to the destination.
Description of Keys inside each JSON object:
| Property | Description |
|---|---|
| type | This is the input field type you want to add |
| label | This is the display name for your field |
| configKey | This is the key to which the value for this field will be stored in the db |
| required | You can provide true as a value to make this field as required or false |
| placeholder | This is the the placeholder for this field |
| secret | You can provide true as a value to make this field as secret or false |
| preRequisites | You can add the configKey and value if you there is a preRequiste field for this field |
The input field types that you can add are:
| type | Description |
|---|---|
| textInput | This is a simple field for adding text inputs |
| checkbox | This is used for boolean values (true or false) |
| singleSelect | This is used for choosing one of the option from a set of defined options |
| multiSelect | This is used for choosing multiple options from a set of defined options |
| tagInput | This can be used to add multiple text inputs for a field |
You can also contribute to any open-source RudderStack project. View our GitHub page to see all the different projects.
For any questions, concerns, or queries, you can start by asking a question in our Slack community.