kylefang/react-native-paper
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-native-paper.git synced 2026-05-23 00:38:28 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
66193fa3d311f50b005da2970acfe9a63668380c
react-native-paper/contributing.html
Circle CI 467141f429 Deploy to GitHub Pages: e2b4ba4da7
2019-03-01 10:52:29 +00:00

140 lines
22 KiB
HTML
Raw Blame History

<html lang="en"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"/><meta name="mobile-web-app-capable" content="yes"/><meta name="apple-mobile-web-app-capable" content="yes"/><meta name="description" content=""/><meta name="twitter:card" content="summary"/><meta name="twitter:title" content="Contributing"/><meta name="twitter:description" content=""/><meta property="og:type" content="website"/><meta property="og:title" content="Contributing"/><meta property="og:description" content=""/><title>Contributing</title><link type="text/css" rel="stylesheet" href="app.css"/></head><body><div id='root'><div class="Layout_lugqar2"><aside class="sidebar_s9nrg4n"><input type="checkbox" class="menuButton_mzfqg8l" id="slide-sidebar" role="button"/><label class="menuIcon_m1mups47" for="slide-sidebar">☰</label><div class="menu_mdzibsv"><img class="logoImage_llziuo3" src="images/sidebar-logo.svg" alt="Logo"/><input type="search" value="" placeholder="Filter…" class="searchbar_s1nn5lbd"/><nav class="navigation_nlggdah"><a class="link_l5q2p2e" href="index.html">Home</a><a class="link_l5q2p2e" href="getting-started.html">Getting Started</a><a class="link_l5q2p2e" href="theming.html">Theming</a><a class="link_l5q2p2e" href="icons.html">Icons</a><a class="link_l5q2p2e" href="using-on-the-web.html">Using on the Web</a><a class="link_l5q2p2e" href="showcase.html">Showcase</a><a class="link_l5q2p2e active_al210no" href="contributing.html">Contributing</a><hr class="separator_s1gpol2t"/><a class="link_l5q2p2e" href="activity-indicator.html">ActivityIndicator</a><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="appbar.html">Appbar</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="appbar-action.html">Appbar.Action</a><a class="link_l5q2p2e" href="appbar-back-action.html">Appbar.BackAction</a><a class="link_l5q2p2e" href="appbar-content.html">Appbar.Content</a><a class="link_l5q2p2e" href="appbar-header.html">Appbar.Header</a></div></div><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="">Avatar</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="avatar-icon.html">Avatar.Icon</a><a class="link_l5q2p2e" href="avatar-image.html">Avatar.Image</a><a class="link_l5q2p2e" href="avatar-text.html">Avatar.Text</a></div></div><a class="link_l5q2p2e" href="badge.html">Badge</a><a class="link_l5q2p2e" href="banner.html">Banner</a><a class="link_l5q2p2e" href="bottom-navigation.html">BottomNavigation</a><a class="link_l5q2p2e" href="button.html">Button</a><a class="link_l5q2p2e" href="caption.html">Caption</a><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="card.html">Card</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="card-actions.html">Card.Actions</a><a class="link_l5q2p2e" href="card-content.html">Card.Content</a><a class="link_l5q2p2e" href="card-cover.html">Card.Cover</a><a class="link_l5q2p2e" href="card-title.html">Card.Title</a></div></div><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="checkbox.html">Checkbox</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="checkbox-android.html">Checkbox.Android</a><a class="link_l5q2p2e" href="checkbox-ios.html">Checkbox.IOS</a></div></div><a class="link_l5q2p2e" href="chip.html">Chip</a><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="data-table.html">DataTable</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="data-table-cell.html">DataTable.Cell</a><a class="link_l5q2p2e" href="data-table-header.html">DataTable.Header</a><a class="link_l5q2p2e" href="data-table-pagination.html">DataTable.Pagination</a><a class="link_l5q2p2e" href="data-table-row.html">DataTable.Row</a><a class="link_l5q2p2e" href="data-table-title.html">DataTable.Title</a></div></div><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="dialog.html">Dialog</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="dialog-actions.html">Dialog.Actions</a><a class="link_l5q2p2e" href="dialog-content.html">Dialog.Content</a><a class="link_l5q2p2e" href="dialog-scroll-area.html">Dialog.ScrollArea</a><a class="link_l5q2p2e" href="dialog-title.html">Dialog.Title</a></div></div><a class="link_l5q2p2e" href="divider.html">Divider</a><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="">Drawer</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="drawer-item.html">Drawer.Item</a><a class="link_l5q2p2e" href="drawer-section.html">Drawer.Section</a></div></div><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="fab.html">FAB</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="fab-group.html">FAB.Group</a></div></div><a class="link_l5q2p2e" href="headline.html">Headline</a><a class="link_l5q2p2e" href="helper-text.html">HelperText</a><a class="link_l5q2p2e" href="icon-button.html">IconButton</a><a class="link_l5q2p2e" href="touchable-ripple.html">TouchableRipple</a><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="">List</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="list-accordion.html">List.Accordion</a><a class="link_l5q2p2e" href="list-icon.html">List.Icon</a><a class="link_l5q2p2e" href="list-item.html">List.Item</a><a class="link_l5q2p2e" href="list-section.html">List.Section</a><a class="link_l5q2p2e" href="list-subheader.html">List.Subheader</a></div></div><a class="link_l5q2p2e" href="modal.html">Modal</a><a class="link_l5q2p2e" href="paragraph.html">Paragraph</a><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="portal.html">Portal</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="portal-host.html">Portal.Host</a></div></div><a class="link_l5q2p2e" href="progress-bar.html">ProgressBar</a><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="radio-button.html">RadioButton</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="radio-button-android.html">RadioButton.Android</a><a class="link_l5q2p2e" href="radio-button-group.html">RadioButton.Group</a><a class="link_l5q2p2e" href="radio-button-ios.html">RadioButton.IOS</a></div></div><a class="link_l5q2p2e" href="searchbar.html">Searchbar</a><a class="link_l5q2p2e" href="snackbar.html">Snackbar</a><a class="link_l5q2p2e" href="subheading.html">Subheading</a><a class="link_l5q2p2e" href="surface.html">Surface</a><a class="link_l5q2p2e" href="switch.html">Switch</a><a class="link_l5q2p2e" href="text.html">Text</a><a class="link_l5q2p2e" href="text-input.html">TextInput</a><a class="link_l5q2p2e" href="title.html">Title</a><div><div class="row_r1ol5l8s"><a class="link_l5q2p2e" href="toggle-button.html">ToggleButton</a><button class="buttonIcon_b1e7pn53 expandedIcon_e12mn27x" style="opacity:0"><svg width="16px" height="16px" viewBox="0 0 16 16"><polygon stroke="none" stroke-width="1" fill-rule="evenodd" fill="currentColor" points="8 4 2 10 3.4 11.4 8 6.8 12.6 11.4 14 10"></polygon></svg></button></div><div class="groupItems_g19yxlm8 groupItemsVisible_g16acsvo"><a class="link_l5q2p2e" href="toggle-button-group.html">ToggleButton.Group</a></div></div></nav></div></aside><main class="Container_c119hgic"><div class="Inner_ir6lat6"><div><h1 id="contributing-to-react-native-paper">
<a class="anchor" href="#contributing-to-react-native-paper">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Contributing to React Native Paper</h1>
<h2 id="code-of-conduct">
<a class="anchor" href="#code-of-conduct">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Code of Conduct</h2>
<p>We want this community to be friendly and respectful to each other. Please read <a href="/CODE_OF_CONDUCT.md">the full text</a> so that you can understand what actions will and will not be tolerated.</p>
<h2 id="our-development-process">
<a class="anchor" href="#our-development-process">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Our Development Process</h2>
<p>The core team works directly on GitHub and all work is public.</p>
<h3 id="development-workflow">
<a class="anchor" href="#development-workflow">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Development workflow</h3>
<blockquote>
<p><strong>Working on your first pull request?</strong> You can learn how from this <em>free</em> series: <a href="https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github">How to Contribute to an Open Source Project on GitHub</a>.</p>
</blockquote>
<ol>
<li>Fork the repo and create your branch from <code>master</code> (a guide on <a href="https://help.github.com/articles/fork-a-repo/">how to fork a repository</a>).</li>
<li>Run <code>yarn bootstrap</code> to setup the development environment.</li>
<li>Do the changes you want and test them out in the example app before sending a pull request.</li>
</ol>
<h3 id="commit-message-convention">
<a class="anchor" href="#commit-message-convention">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Commit message convention</h3>
<p>We follow the <a href="https://www.conventionalcommits.org/en">conventional commits specification</a> for our commit messages:</p>
<ul>
<li><code>fix</code>: bug fixes, e.g. fix Button color on DarkTheme.</li>
<li><code>feat</code>: new features, e.g. add Snackbar component.</li>
<li><code>refactor</code>: code refactor, e.g. new folder structure for components.</li>
<li><code>docs</code>: changes into documentation, e.g. add usage example for Button.</li>
<li><code>test</code>: adding or updating tests, eg unit, snapshot testing.</li>
<li><code>chore</code>: tooling changes, e.g. change circleci config.</li>
<li><code>BREAKING CHANGE</code>: for changes that break existing usage, e.g. change API of a component.</li>
</ul>
<p>Our pre-commit hooks verify that your commit message matches this format when committing.</p>
<h3 id="linting-and-tests">
<a class="anchor" href="#linting-and-tests">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Linting and tests</h3>
<p>We use <code>flow</code> for type checking, <code>eslint</code> with <code>prettier</code> for linting and formatting the code, and <code>jest</code> for testing. Our pre-commit hooks verify that the linter and tests pass when commiting. You can also run the following commands manually:</p>
<ul>
<li><code>yarn flow</code>: run flow on all files.</li>
<li><code>yarn typescript</code>: run tests for typescript definitions.</li>
<li><code>yarn lint</code>: lint files with eslint and prettier.</li>
<li><code>yarn test</code>: run unit tests with jest.</li>
</ul>
<h3 id="sending-a-pull-request">
<a class="anchor" href="#sending-a-pull-request">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Sending a pull request</h3>
<p>When you're sending a pull request:</p>
<ul>
<li>Prefer small pull requests focused on one change.</li>
<li>Verify that <code>flow</code>, <code>eslint</code> and all tests are passing.</li>
<li>Preview the documentation to make sure it looks good.</li>
<li>Follow the pull request template when opening a pull request.</li>
</ul>
<p>When you're working on a component:</p>
<ul>
<li>Follow the guidelines described in the <a href="https://material.io/guidelines/">official material design docs</a>.</li>
<li>Write a brief description of every prop when defining <code>type Props</code> to aid with documentation.</li>
<li>Provide an example usage for the component (check other components to get a idea).</li>
<li>Update the type definitions for Flow and Typescript if you changed an API or added a component.</li>
</ul>
<h3 id="running-the-example">
<a class="anchor" href="#running-the-example">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Running the example</h3>
<p>The example app uses <a href="https://expo.io/">Expo</a> for the React Native example. You will need to install the Expo app for <a href="https://play.google.com/store/apps/details?id=host.exp.exponent">Android</a> and <a href="https://itunes.apple.com/app/apple-store/id982107779">iOS</a> to start developing.</p>
<p>After you're done, you can run <code>yarn example start</code> in the project root (or <code>expo start</code> in the <code>example/</code> folder) and scan the QR code to launch it on your device.</p>
<p>To run the example on web, run <code>yarn example web</code> in the project root.</p>
<h3 id="working-on-documentation">
<a class="anchor" href="#working-on-documentation">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Working on documentation</h3>
<p>The documentation is automatically generated from the <a href="https://flowtype.org">flowtype</a> annotations in the components. You can add comments above the type annotations to add descriptions. To preview the generated documentation, run <code>yarn docs start</code> in the project root.</p>
<h3 id="publishing-a-release">
<a class="anchor" href="#publishing-a-release">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Publishing a release</h3>
<p>We use <a href="https://github.com/webpro/release-it">release-it</a> to automate our release. If you have publish access to the NPM package, run the following from the master branch to publish a new release:</p>
<pre><code class="language-sh">yarn release</code></pre>
<p>NOTE: You must have a <code>GITHUB_TOKEN</code> environment variable available. You can create a GitHub access token with the "repo" access <a href="https://github.com/settings/tokens">here</a>.</p>
<h2 id="reporting-issues">
<a class="anchor" href="#reporting-issues">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
Reporting issues</h2>
<p>You can report issues on our <a href="https://github.com/callstack/react-native-paper/issues">bug tracker</a>. Please follow the issue template when opening an issue.</p>
<h2 id="license">
<a class="anchor" href="#license">
<svg width="16" height="16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</svg>
</a>
License</h2>
<p>By contributing to React Native Paper, you agree that your contributions will be licensed under its <strong>MIT</strong> license.</p>
</div></div></main></div></div>
<script>
window.__INITIAL_PATH__ = 'contributing';
</script>
<script src="app.bundle.js"></script><script src="scripts/snack.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink