Skip to content

Commit 3b3f5bd

Browse files
authored
Update readme (#102)
* Update documentation * Update example app * Update documentation * Update documentation * Update documentation * Update documentation * Update README.md * Update README.md * Update README.md * Add contributions guideline * Update CHANGELOG.md * Fix lint error
1 parent fff6c3f commit 3b3f5bd

28 files changed

+1428
-538
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
## 1.1.4
2+
3+
### Improvements
4+
- Add swap animation when changing the order of items in the list
5+
- Add 'enableSwap' to enable/disable swap animation
6+
- Add 'nonDraggableItems' to make items non-draggable and enable/disable reordering
7+
- Add `dragStartDelay` to delay the start of the drag gesture
8+
- Deprecate 'longPressDrag' in favor of `dragStartDelay`
9+
- Update Example App
10+
111
## 1.1.3
212

313
### Bug fixes

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
Thank you so much for your interest in contributing! All types of contributions are encouraged and valued. The Project Team looks forward to your contributions.
3+
4+
## Filing issues
5+
When in doubt, file an issue. We'd rather close a few duplicate issues than let a problem go unnoticed.
6+
Similarly, if you support a particular feature request, please let us know by commenting on the issue or [subscribing](https://help.github.com/articles/subscribing-to-conversations/) to the issue.
7+
8+
If you are reporting a bug, please help speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project (or gist) that reproduces the problem.
9+
10+
11+
## Contributing code
12+
We actively welcome your pull requests.
13+
1. Fork the repo and create your branch from `main`.
14+
2. If you've added code that should be tested, add tests
15+
4. Make sure your code lints.
16+
17+
## Labels
18+
Labels on issues are managed by contributors, you don't have to worry about them. Here's a list of what they mean:
19+
20+
* **bug**: feature that should work, but doesn't
21+
* **enhancement**: minor tweak/addition to existing behaviour
22+
* **feature**: new behaviour, bigger than enhancement
23+
* **question**: no need of any fix, usually a usage problem
24+
* **reproducible**: has enough information to very easily reproduce, mostly in the form of a small project in a GitHub repo
25+
* **repro-needed**: we need some code to be able to reproduce and debug locally, otherwise there's not much we can do
26+
* **duplicate**: there's another issue which already covers/tracks this
27+
* **wontfix**: working as intended, or won't be fixed due to compatibility or other reasons
28+
* **invalid**: there isn't enough information to make a verdict, or unrelated
29+
* **non-library**: issue is not in the core library code, but rather in documentation, samples, build process, releases
30+
31+
## License
32+
By contributing to animated_reorderable_list, you agree that your contributions will be licensed under its Apache License, Version 2.0. See LICENSE file for details.

0 commit comments

Comments
 (0)