forked from line/line-bot-sdk-nodejs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
CONTRIBUTING.html
36 lines (35 loc) · 15.3 KB
/
CONTRIBUTING.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>How to contribute to LINE Bot SDK for Node.js | line-bot-sdk-nodejs</title>
<meta name="description" content="Node.js SDK for LINE Messaging API">
<link rel="icon" href="/line-bot-sdk-nodejs/favicon.ico">
<link rel="preload" href="/line-bot-sdk-nodejs/assets/css/styles.beba238d.css" as="style"><link rel="preload" href="/line-bot-sdk-nodejs/assets/js/app.beba238d.js" as="script"><link rel="preload" href="/line-bot-sdk-nodejs/assets/js/3.00fd5155.js" as="script"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/7.0cadc9bb.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/css/1.styles.5a8ea794.css"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/1.5a8ea794.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/css/2.styles.4217617d.css"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/2.4217617d.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/4.0a538e22.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/5.6a811e23.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/6.db9c4c3b.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/8.111766d2.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/9.4e1c3eeb.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/10.c105c408.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/11.36ed3bdb.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/12.3292ae03.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/13.e721f3ae.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/14.b91ba6be.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/15.f132f0db.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/16.663417a1.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/17.bb496f13.js"><link rel="prefetch" href="/line-bot-sdk-nodejs/assets/js/18.884079c0.js">
<link rel="stylesheet" href="/line-bot-sdk-nodejs/assets/css/1.styles.5a8ea794.css"><link rel="stylesheet" href="/line-bot-sdk-nodejs/assets/css/2.styles.4217617d.css"><link rel="stylesheet" href="/line-bot-sdk-nodejs/assets/css/styles.beba238d.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/line-bot-sdk-nodejs/" class="home-link router-link-active"><!----> <span class="site-name">line-bot-sdk-nodejs</span></a> <div class="links" style="max-width:nullpx;"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/line-bot-sdk-nodejs/" class="nav-link">Introduction</a></div><div class="nav-item"><a href="/line-bot-sdk-nodejs/getting-started.html" class="nav-link">Getting Started</a></div><div class="nav-item"><a href="/line-bot-sdk-nodejs/guide.html" class="nav-link">Guide</a></div><div class="nav-item"><a href="/line-bot-sdk-nodejs/api-reference.html" class="nav-link">API Reference</a></div><div class="nav-item"><a href="/line-bot-sdk-nodejs/CONTRIBUTING.html" class="nav-link router-link-exact-active router-link-active">Contributing</a></div><div class="nav-item"><a href="https://developers.line.me/en/" target="_blank" rel="noopener noreferrer" class="nav-link external">
LINE Developers
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><a href="https://github.com/line/line-bot-sdk-nodejs/" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <div class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/line-bot-sdk-nodejs/" class="nav-link">Introduction</a></div><div class="nav-item"><a href="/line-bot-sdk-nodejs/getting-started.html" class="nav-link">Getting Started</a></div><div class="nav-item"><a href="/line-bot-sdk-nodejs/guide.html" class="nav-link">Guide</a></div><div class="nav-item"><a href="/line-bot-sdk-nodejs/api-reference.html" class="nav-link">API Reference</a></div><div class="nav-item"><a href="/line-bot-sdk-nodejs/CONTRIBUTING.html" class="nav-link router-link-exact-active router-link-active">Contributing</a></div><div class="nav-item"><a href="https://developers.line.me/en/" target="_blank" rel="noopener noreferrer" class="nav-link external">
LINE Developers
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><a href="https://github.com/line/line-bot-sdk-nodejs/" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><div class="sidebar-group first"><p class="sidebar-heading"><span>Introduction</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/line-bot-sdk-nodejs/" class="sidebar-link">LINE Messaging API SDK for nodejs</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Getting Started</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/line-bot-sdk-nodejs/getting-started/requirements.html" class="sidebar-link">Requirements</a></li><li><a href="/line-bot-sdk-nodejs/getting-started/install.html" class="sidebar-link">Install</a></li><li><a href="/line-bot-sdk-nodejs/getting-started/basic-usage.html" class="sidebar-link">Basic Usage</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Guide</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/line-bot-sdk-nodejs/guide/webhook.html" class="sidebar-link">Webhook</a></li><li><a href="/line-bot-sdk-nodejs/guide/client.html" class="sidebar-link">Client</a></li><li><a href="/line-bot-sdk-nodejs/guide/typescript.html" class="sidebar-link">TypeScript</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>API Reference</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/line-bot-sdk-nodejs/api-reference/client.html" class="sidebar-link">new Client(config)</a></li><li><a href="/line-bot-sdk-nodejs/api-reference/validate-signature.html" class="sidebar-link">validateSignature(body, channelSecret, signature)</a></li><li><a href="/line-bot-sdk-nodejs/api-reference/middleware.html" class="sidebar-link">middleware(config)</a></li><li><a href="/line-bot-sdk-nodejs/api-reference/exceptions.html" class="sidebar-link">Exceptions</a></li><li><a href="/line-bot-sdk-nodejs/api-reference/message-and-event-objects.html" class="sidebar-link">Message and event objects</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading open"><span>Contributing</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/line-bot-sdk-nodejs/CONTRIBUTING.html" class="active sidebar-link">How to contribute to LINE Bot SDK for Node.js</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/line-bot-sdk-nodejs/CONTRIBUTING.html#development" class="sidebar-link">Development</a></li><li class="sidebar-sub-header"><a href="/line-bot-sdk-nodejs/CONTRIBUTING.html#contributor-license-agreement" class="sidebar-link">Contributor license agreement</a></li></ul></li></ul></div></li></ul> </div> <div class="page"> <div class="content"><h1 id="how-to-contribute-to-line-bot-sdk-for-node-js"><a href="#how-to-contribute-to-line-bot-sdk-for-node-js" aria-hidden="true" class="header-anchor">#</a> How to contribute to LINE Bot SDK for Node.js</h1> <p>First of all, thank you so much for taking your time to contribute! LINE Bot 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:</p> <ul><li>File an issue in <a href="https://github.com/line/line-bot-sdk-nodejs/issues" target="_blank" rel="noopener noreferrer">the issue tracker<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>
to report bugs and propose new features and improvements.</li> <li>Ask a question using <a href="https://github.com/line/line-bot-sdk-nodejs/issues" target="_blank" rel="noopener noreferrer">the issue tracker<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>.</li> <li>Contribute your work by sending <a href="https://github.com/line/line-bot-sdk-nodejs/pulls" target="_blank" rel="noopener noreferrer">a pull request<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>.</li></ul> <h2 id="development"><a href="#development" aria-hidden="true" class="header-anchor">#</a> Development</h2> <p>You can freely fork the project, clone the forked repository, and start editing.</p> <p>Here are each top-level directory explained:</p> <ul><li><code>lib</code>: TypeScript source code. You may modify files under this directory.</li> <li><code>test</code>: Mocha test suites. Please add tests for modification if possible.</li> <li><code>examples</code>: Example projects using this SDK</li> <li><code>docs</code>: <a href="https://vuepress.vuejs.org" target="_blank" rel="noopener noreferrer">VuePress<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> markdowns for project documentation</li> <li><code>tools</code>: Useful tools</li></ul> <p>Also, you may use the following npm scripts for development:</p> <ul><li><code>npm run test</code>: Run test suites in <code>test</code>.</li> <li><code>npm run format</code>: Format source code with <a href="https://github.com/prettier/prettier" target="_blank" rel="noopener noreferrer">Prettier<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></li> <li><code>npm run format:check</code>: Silently run <code>format</code> and report formatting errors</li> <li><code>npm run build</code>: Build TypeScript code into JavaScript. The built files will
be placed in <code>dist/</code>.</li> <li><code>npm run docs</code>: Build and serve documentation</li></ul> <p>We test, lint and build on CI, but it is always nice to check them before
uploading a pull request.</p> <h2 id="contributor-license-agreement"><a href="#contributor-license-agreement" aria-hidden="true" class="header-anchor">#</a> Contributor license agreement</h2> <p>When you are sending a pull request and it's a non-trivial change beyond fixing typos, please make sure to sign
<a href="https://cla-assistant.io/line/line-bot-sdk-nodejs" target="_blank" rel="noopener noreferrer">the ICLA (individual contributor license agreement)<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>. Please
<a href="mailto:dl_oss_dev@linecorp.com">contact us</a> if you need the CCLA (corporate contributor license agreement).</p></div> <div class="page-edit"><!----> <!----></div> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/line-bot-sdk-nodejs/api-reference/message-and-event-objects.html" class="prev">
Message and event objects
</a></span> <!----></p></div> </div> <!----></div></div>
<script src="/line-bot-sdk-nodejs/assets/js/3.00fd5155.js" defer></script><script src="/line-bot-sdk-nodejs/assets/js/app.beba238d.js" defer></script>
</body>
</html>