Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
nicastelo committed Jan 16, 2020
0 parents commit a1b46c7
Show file tree
Hide file tree
Showing 19 changed files with 10,147 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
lib/
3 changes: 3 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
extends: '@react-native-community',
};
12 changes: 12 additions & 0 deletions .flowconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[ignore]

[include]

[libs]
flow-typed

[lints]

[options]

[strict]
23 changes: 23 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OSX
#
.DS_Store

# node.js
#
node_modules
npm-debug.log
yarn-error.log

# webstorm
#
*.iml
.idea

# unfinished documents
#
cn-doc.md

# VS Code
.vscode/

lib
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"singleQuote": true,
"trailingComma": "all"
}
Empty file added CHANGELOG.md
Empty file.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing to React Native Swipeable Lists

Thank you for helping out with react-native-swipeable-lists!
We'd like to make contributions as pleasant as possible, so here's a small guide of how we see it. Happy to hear your feedback about anything, so please let us know.

### Modifying react-native-swipeable-lists

1. Fork this repository
2. Clone your fork
3. Make a branch for your feature or bug fix (i.e. `git checkout -b added-getfoobar`)
4. Work your magic
5. Execute `yarn link` when done.

### Testing your changes

You can test your changes on any React Native application you have set up locally.

## Sending a pull request

When you're sending a pull request:

- Communication is a key. If you want fix/add something, please open new/find existing issue, so we can discuss it.
- Small pull requests focused on one change are preferred, as those are easier to test/check.

## Commits and versioning

All PRs are merged into the `master` branch, following [conventional commit message](https://www.conventionalcommits.org/en/v1.0.0-beta.3). Combined with [semantic versioning](https://semver.org/), this allows us to have a frequent releases of the library.

Most notably prefixes you'll see:

- **fix**: Bug fixes, triggers _patch_ release
- **feat**: New feature implemented, triggers _minor_
- **chore**: Changes that are not affecting end user (CI config changes, scripts, ["grunt work"](https://stackoverflow.com/a/26944812/3510245))
- **docs**: Documentation changes.
- **perf**: A code change that improves performance.
- **refactor**: A code change that neither fixes a bug nor adds a feature.
- **test**: Adding missing tests or correcting existing tests.

## Release process

We use [Semantic Release](http://semantic-release.org) to release new versions of the library when changes are merged into the `master` branch, which we plan to keep stable. Bug fixes take priority in the release order. The master branch should always contain the latest released code.

## Reporting issues

You can report issues on the [bug tracker](https://github.com/nicastelo/react-native-swipeable-lists/issues). Please search for existing issues and follow the issue template when opening an one. Except no need to add any notes to the changelog as semtice released handles that automatically based on the commit messages.

## License

By contributing to React Native Swipeable Lists, you agree that your contributions will be licensed under the **MIT** license.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2015-present, Facebook, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## react-native-swipeable-lists

[![Version](https://img.shields.io/npm/v/react-native-swipeable-lists.svg)](https://www.npmjs.com/package/react-native-swipeable-lists)
[![NPM](https://img.shields.io/npm/dm/react-native-swipeable-lists.svg)](https://www.npmjs.com/package/react-native-swipeable-lists)

Swipeable lists for React Native. Supports Android and iOS.

- [Installation](#installation)
- [Opening issues](#opening-issues)
- [Usage](#usage)
- [Components](#components)
- [SwipeableFlatList](#swipeablefaltlist)
- [TODO](#todo)

### Installation

```bash
yarn add react-native-swipeable-lists
```
or

```bash
npm install react-native-swipeable-lists
```

### Opening issues

Verify that it is still an issue with the latest version as specified in the previous step. If so, open a new issue, include the entire `App.js` file, specify what platforms you've tested, and the results of running this command:

```bash
react-native info
```

### Usage
[TO BE DESCRIBED]

### Components:

#### SwipeableFaltList
[TO BE DESCRIBED]

### TODO:

1. Add usage to the Readme
2. Add example

### Tested with:

- react-native >= 0.59.10 <= 0.61

---

This code was initially ported from React Native on its version 0.59.10 as they dropped it on the next one.
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: ['module:metro-react-native-babel-preset'],
};

0 comments on commit a1b46c7

Please sign in to comment.