Skip to content
This repository has been archived by the owner on May 30, 2023. It is now read-only.

Latest commit

 

History

History
34 lines (23 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.59 KB

How to contribute to LINE CEK SDK for Node.js

First of all, thank you so much for taking your time to contribute! LINE CEK SDK for Node.js is not very different from any other open source projects. It will be fantastic if you help us by doing any of the following:

Development

You can freely fork the project, clone the forked repository, and start editing.

Here are each top-level directory explained:

  • src: TypeScript source code. You may modify files under this directory.
  • test: Jest test suites. Please add tests for modification if possible.
  • examples: Example projects using this SDK

Also, you may use the following npm scripts for development:

  • npm run test: Run test suites in test.
  • npm run build: Build TypeScript code into JavaScript. The built files will be placed in dist/.

We test, lint and build on CI, but it is always nice to check them before uploading a pull request.

Contributor license agreement

When you are sending a pull request and it's a non-trivial change beyond fixing typos, please sign the ICLA (individual contributor license agreement). Please contact us if you need the CCLA (corporate contributor license agreement).