Adds two numbers
example:
const result = sum(1, 2)
// result === 3
TODO - add description and example
TODO - add description and example
Testing: Test your changes with yarn test
or yarn test:watch
Commit messages: This repo follows the conventional commits guidelines. Make your commit messages in the following format:
<type>[scope]: <description>
[optional body]
[optional footer(s)]
Use the appropriate type
for what your commit does:
feat
: adds a new featuretest
: adds or improves testschore
: odd jobs that do not affect the functionality of the codeci
: makes changes to the CIdocs
: adds or improves documentationperf
: makes performance improvementsstyle
: makes styling changesrefactor
: internal changes have been made, but API input and output remain the same
And the scope
is one of:
lib
: changes to anything within./src
repo
: repository-level changes (such as linting config, etc)
Some examples:
chore(repo): update eslint config
feat(lib): add new 'sum' export
test(lib): add more tests for arrayify
ci(repo): fix Publish to NPM workflow
refactor(lib): convert JS files to typescript
perf(lib): improve performance for arrayify
feat(lib): BREAKING CHANGE replace second argument of function X to options object