Add Utilities, CI Workflow, and Documentation Enhancements#2
Merged
Conversation
Introduced GitHub issue templates for bug reports and utility proposals, and added a config to guide user contributions. Enhanced the README with new badges and a visual header, expanded keywords in package.json for better discoverability, and updated typedoc.json with custom footer, hidden generator, project documents, and cname for documentation.
Introduces an Environment enum and utility functions to detect production, development, test, Node.js, and browser environments. Includes comprehensive unit tests for environment checks.
Updated the README to provide clearer usage instructions, including modular, full, and CommonJS import examples. Added a new FAQ section, clarified requirements, and improved contribution guidelines for better onboarding and user experience.
Introduces a workflow that runs tests on pull requests and pushes to the main branch. Includes a manual approval step for pull requests before tests are executed.
teneplaysofficial
temporarily deployed
to
test-approval
GitHub Actions
Inactive
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
1 participant
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.
Description
This PR adds new utility functions, a GitHub Actions test workflow with approval gates, and various documentation and metadata improvements.
Utilities
numberclamp()isEven()isOdd()randomInt()randomFloat()environmentEnvironmentenumisNode()isBrowser()isDev()isProd()isTest()getRunTimeEnvironmentCI Workflow
Documentation and Metadata
README.mdwith examples, FAQ, and contribution guidelinestypedoc.jsonconfigurationpackage.jsonkeywords