CONTRIBUTING.md

Contributing

Installation

Clone the repository.

git clone git@github.com:bradtaniguchi/codewars-node-api.git
cd codewars-node-api

Install required Node.js version in your machine as mentioned in .nvmrc

or

If you have nvm installed, run the command

nvm use

Install the dependencies

npm install

Summary

Contributing to this library can be done using any environment of your choice. Currently development is focused on using node.js, further details are on the way. Anyone can currently do the following:

• open issues for features or bugs
• open pull request(s) for existing issues
• update documentation for this project

Direct contributions to the code require opening an issue first to discuss the feature, since the project is still a work in progress.

Linting the code

To lint the code use the command:

npm run lint

Building code

To build the code use the command:

npm run build

This will create a lib folder, which will house the exported js and .d.ts files.

Building docs

To build the typedoc based doc site, use the command:

npm run build:docs

To serve the docs locally you can use:

npm run smoke:docs

Running sanity tests

Currently we use jest to run some sanity checks against the actual code and API calls. These do not need to be ran locally, as the github-actions pipelines will check them automatically during PR review.

npm run test

Creating new release

(for maintainers only)

Releases are handled by github and published to npm. To create a new release, create a new tag via npm version <major|minor|patch>

Then push the tag/changes to github via git push --tags.

Once this is pushed, then create a new release on github, and publish the release notes.

External Resources

Below is the official api docs, which this api is based off of. This could be subject to change. https://dev.codewars.com/#introduction

Have Questions?

Feel free to open an issue asking for help/support here