|
| 1 | +# Contributing |
| 2 | + |
| 3 | +`@nrfcloud/lambda-helpers` is a published library: it provides helper functions |
| 4 | +for AWS Lambda functions used in nRF Cloud and is published to |
| 5 | +[JSR](https://jsr.io/@nrfcloud/lambda-helpers). |
| 6 | + |
| 7 | +## Development setup |
| 8 | + |
| 9 | +1. Ensure you |
| 10 | + [have GitHub push access](https://nordicsemi.atlassian.net/wiki/spaces/MFLT/pages/1727136233/Nordic+Engineering+Tools+Setup+go+eng-tools#nRFCloud-Organization). |
| 11 | +1. Get your environment set up by running `npm ci` |
| 12 | +1. Make your changes locally in a git clone of the repo in your own branch. |
| 13 | +1. As you go, commit along the way so that you get type checking, testing, etc. |
| 14 | + to run. |
| 15 | + |
| 16 | +## Testing |
| 17 | + |
| 18 | +1. Run `npx tsgo` to type-check the project. |
| 19 | +1. Run `npm test` to run the unit tests. |
| 20 | + |
| 21 | +## Releasing a new version |
| 22 | + |
| 23 | +1. Finally, create a commit that packages up all the changes. |
| 24 | +1. Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) |
| 25 | + (e.g. `fix:`, `feat:`, etc.) to prefix the title. |
| 26 | +1. Reference any applicable Jira tickets (e.g. `NPE-123`) in the commit message. |
| 27 | +1. Push your branch and create a pull request. |
| 28 | +1. Get the code reviewed. |
| 29 | +1. Once approved and CI passes, rebase or squash away! |
| 30 | +1. [`semantic-release` in the Test&Release workflow](.github/workflows/test-and-release.yaml) |
| 31 | + takes care of creating a new GitHub release and publishing the package to |
| 32 | + [JSR](https://jsr.io/@nrfcloud/lambda-helpers). |
| 33 | + |
| 34 | +Now that you have a new version of `@nrfcloud/lambda-helpers` published, you can |
| 35 | +bump the dependency in the projects that consume it. |
0 commit comments