Skip to content

Commit 3f9dd67

Browse files
committed
docs: add CONTRIBUTING.md with development, testing and release instructions
1 parent 2e2a056 commit 3f9dd67

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

CONTRIBUTING.md

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

0 commit comments

Comments
 (0)