Skip to content

add contributing section to readme and clarify install #13

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

Merged
hobbitronics merged 2 commits into from
Feb 17, 2026
Merged

add contributing section to readme and clarify install #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a346935
add contributing section to readme and clarify install
hobbitronics Feb 17, 2026
f9b6938
PR suggestions
hobbitronics Feb 17, 2026
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
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,25 @@ The following categories of utilities are available under /utils:

## Import Example

To use these utilities in your Pipedream, install them via NPM:
To use these utilities, install via NPM (optional for Pipedream) in your local environment:

```bash

npm install @sil-org/pipedream-utils
```

and import the category/ies of functions you want.
or in Pipedream just import the category/ies of functions you want.

`import { helpers, netsuite } from '@sil-org/pipedream-utils'`
`import { helpers, netsuite } from '@sil-org/pipedream-utils@^0.3.0'`

## Contributing

Use the recommended extensions with VSCode/VSCodium.

If using a different IDE, read the .vscode/extensions.json file and install the equivalent extensions in your environment.

Use the scripts in package.json to test, lint and format your code.

The actions will check it when you push.

The "Publish" action must be triggered manually in Github after updating the package.json version (and running `npm i` to update it in the lock file.)