Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request sets up the foundational project structure and tooling for the ZipTax Node.js SDK. It introduces configuration and workflow files for development, testing, linting, formatting, publishing, and environment management. It also adds documentation, licensing, and example usage scripts to help users get started quickly and understand the SDK's capabilities.
The most important changes are:
Project Configuration and Tooling:
.eslintrc.jsonand.prettierrc.jsonfor TypeScript linting and code formatting standards. [1] [2].npmignoreto ensure only necessary files are published to npm..env.exampleto provide a template for required environment variables, including the ZipTax API key.CI/CD Workflows:
test.yml) and publishing (publish.yml) the package, supporting multi-platform testing, linting, type checking, coverage reporting, and automated npm publishing. [1] [2]Documentation and Licensing:
README.mdwith installation, usage, API reference, error handling, examples, and contribution guidelines.CHANGELOG.mdfollowing Keep a Changelog and Semantic Versioning.LICENSEfile.Example Scripts:
examples/directory to demonstrate SDK features and best practices. [1] [2] [3]