From 9aef3d455076a2d024150a40491071b9be0730c9 Mon Sep 17 00:00:00 2001 From: evgeny Date: Tue, 10 Mar 2026 18:37:00 +0000 Subject: [PATCH 1/2] chore: bump version to 1.0.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3cb1b65..01bc722 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ably/text-decoder", - "version": "0.0.1", + "version": "1.0.0", "description": "A light-weight TextDecoder polyfill for React Native Hermes that only supports utf-8", "type": "module", "types": "./build/index.d.ts", From b639573fe3ee276cad5856c0fa017e737bff711a Mon Sep 17 00:00:00 2001 From: evgeny Date: Tue, 10 Mar 2026 18:37:21 +0000 Subject: [PATCH 2/2] chore: add changelog and contributing --- CHANGELOG.md | 11 +++++++++++ CONTRIBUTING.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5b7dd2f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Change Log + +This contains only the most important and/or user-facing changes; for a full changelog, see the commit history. + +## [1.0.0](https://github.com/ably-forks/text-decoder/tree/1.0.0) (2026-03-10) + +Initial release of `@ably/text-decoder` — a lightweight UTF-8 TextDecoder polyfill for React Native. + +- Zero-dependency UTF-8 TextDecoder implementation +- CommonJS and ES module support +- TypeScript type definitions diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f3a302d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# Contributing to ably/text-decoder + +## Contributing + +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Ensure you have added suitable tests and the test suite is passing (`npm test`) +5. Push the branch (`git push origin my-new-feature`) +6. Create a new Pull Request + +## Release Process + +1. Make sure the tests are passing in CI for the branch you're building +2. Create a new branch for the release, for example `release/1.2.3` +3. Update the `CHANGELOG.md` with any customer-affecting changes since the last release and add this to the git index +4. Run `npm version --no-git-tag-version` with the new version and add the changes to the git index +5. Create a PR for the release branch +6. Once the release PR is landed to the `main` branch, checkout the `main` branch locally (remember to pull the remote changes) +7. Run `git tag ` with the new version and push the tag to GitHub with `git push ` (usually `git push origin `) +8. Run `npm publish .` (should require OTP) - publishes to npm +9. Visit https://github.com/ably-forks/text-decoder/tags and create a GitHub release based on the new tag (for release notes, you can copy the notes you added to the CHANGELOG) + +## Building the library + +To build the library, run: + + npm run build + +## Test suite + +To run the tests: + + npm test + +To run tests in watch mode: + + npm run test:watch + +## Formatting / linting + +Run the following command to fix linting issues: + + npm run lint:fix \ No newline at end of file