Merge branch 'main' into typescript

CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing
+
+We'd be happy to accept pull requests. If you plan on working on something big, please first drop us a line!
+
+## Getting started
+
+To get started, first fork the project on GitHub and clone the project using Git.
+
+## Dependencies management
+
+This project uses [Yarn](https://yarnpkg.com) 4 for dependency management. To install dependencies, run the following command from the project root:
+
+```sh
+yarn install
+```
+
+To check for updates, run:
+
+```sh
+yarn upgrade-interactive
+```
+
+## Linting
+
+This project is linted using [ESLint](https://eslint.org). You can lint the project by running:
+
+```sh
+yarn eslint .
+```
+
+## Formatting
+
+This project is formatted using [Prettier](https://prettier.io). You can check format the project:
+
+```sh
+prettier --write .
+```
+
+## Testing
+
+This project is tested using [Vitest](https://vitest.dev). There are two kinds of tests.
+
+### Unit tests
+
+Unit tests are in the [`test/unit`](test/unit) folder of the project. You can run them using the following command:
+
+```sh
+yarn vitest test/unit
+```
+
+### Integration tests
+
+Integration tests are in the [`test/integration`](test/integration) folder. They require some extra setup.
+
+Firstly, these tests require the Cloudflare executable. You can download this with:
+
+```sh
+curl -fsSLo cloudflared-linux-amd64 https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-amd64
+chmod +x cloudflared-linux-amd64
+```
+
+They also require a Transloadit key and secret, which you can get from https://transloadit.com/c/credentials.
+
+You can run the integration tests with:
+
+```sh
+TRANSLOADIT_KEY='YOUR_TRANSLOADIT_KEY' TRANSLOADIT_SECRET='YOUR_TRANSLOADIT_SECRET' CLOUDFLARED_PATH='./cloudflared-linux-amd64' vitest run test/integration
+```
+
+## Releasing
+
+Only maintainers can make releases. Releases to [npm](https://www.npmjs.com) are automated using GitHub actions. To make a release, perform the following steps:
+
+1. Update the version using Yarn, e.g. `yarn version patch`. This will create a new Git commit and tag.
+2. Push the tag to GitHub.
+   ```sh
+   git push origin main --tags
+   ```
+3. If the tests pass, GitHub actions will now publish the new version to npm.
+4. When successful add [release notes](https://github.com/transloadit/node-sdk/releases).

README.md

@@ -451,31 +451,14 @@ DEBUG=transloadit* node examples/template_api.js
 
 - [Mikael Finstad](https://github.com/mifi)
 
-## Contributing
-
-We'd be happy to accept pull requests. If you plan on working on something big, please first drop us a line!
-
-### Testing
-
-Check your sources for linting errors via `npm run lint`, and unit tests, and run them via `npm test`
-
-### Releasing
-
-1. Install [np](https://github.com/sindresorhus/np): `npm i -g np`
-2. Wait for [tests to succeed](https://github.com/transloadit/node-sdk/actions).
-3. Run `np` and follow instructions.
-4. When successful add [release notes](https://github.com/transloadit/node-sdk/releases).
-
-### Change log
+### Changelog
 
 See [Releases](https://github.com/transloadit/node-sdk/releases)
 
-### Convenience
+## Attribution
 
-If you come from a unix background and fancy faster auto-complete, you'll be delighted to know that all npm scripts are also accessible under `make`, via fakefile.
+Thanks to [Ian Hansen](https://github.com/supershabam) for donating the `transloadit` npm name. You can still access his code under [`v0.0.0`](https://www.npmjs.com/package/transloadit/v/0.0.0).
 
 ## License
 
-[MIT](LICENSE)
-
-Thanks to [Ian Hansen](https://github.com/supershabam) for donating the `transloadit` npm name. You can still access his code under `v0.0.0`.
+[MIT](LICENSE) © [Transloadit](https://transloadit.com)