Update contributing guide and README for 4.0
This commit is contained in:
parent
7edf0e3ebe
commit
e63c0ce6a0
@ -57,13 +57,6 @@ Before starting work on a major feature for Select2, **contact the
|
|||||||
time on something which the project developers are not interested in bringing
|
time on something which the project developers are not interested in bringing
|
||||||
into the project.
|
into the project.
|
||||||
|
|
||||||
### Select2 4.0
|
|
||||||
|
|
||||||
Many feature requests will be closed off until 4.0, where Select2 plans to adopt
|
|
||||||
a more flexible API. If you are interested in helping with the development of
|
|
||||||
the next major Select2 release, please send a message to the
|
|
||||||
[mailing list][mailing-list] or [irc channel][irc-channel] for more information.
|
|
||||||
|
|
||||||
Triaging issues and pull requests
|
Triaging issues and pull requests
|
||||||
---------------------------------
|
---------------------------------
|
||||||
Anyone can help the project maintainers triage issues and review pull requests.
|
Anyone can help the project maintainers triage issues and review pull requests.
|
||||||
@ -92,9 +85,8 @@ submitted code, or know of a better way to do something, do not hesitate to make
|
|||||||
a comment on the pull request.
|
a comment on the pull request.
|
||||||
|
|
||||||
It should also be made clear that **all code contributed to Select** must be
|
It should also be made clear that **all code contributed to Select** must be
|
||||||
licensable under the [Apache 2 or GPL 2 licenses][licensing]. Code that cannot
|
licensable under the [MIT license][licensing]. Code that cannot be released
|
||||||
be released under either of these licenses **cannot be accepted** into the
|
under either of these licenses **cannot be accepted** into the project.
|
||||||
project.
|
|
||||||
|
|
||||||
[community]: https://select2.github.io/community.html
|
[community]: https://select2.github.io/community.html
|
||||||
[reporting-bugs]: #reporting-bugs-with-select2
|
[reporting-bugs]: #reporting-bugs-with-select2
|
||||||
|
@ -5,11 +5,10 @@ Select2 is a jQuery-based replacement for select boxes. It supports searching,
|
|||||||
remote data sets, and pagination of results.
|
remote data sets, and pagination of results.
|
||||||
|
|
||||||
To get started, checkout examples and documentation at
|
To get started, checkout examples and documentation at
|
||||||
http://select2.github.io/select2
|
http://select2.github.io/
|
||||||
|
|
||||||
Use cases
|
Use cases
|
||||||
---------
|
---------
|
||||||
|
|
||||||
* Enhancing native selects with search.
|
* Enhancing native selects with search.
|
||||||
* Enhancing native selects with a better multi-select interface.
|
* Enhancing native selects with a better multi-select interface.
|
||||||
* Loading data from JavaScript: easily load items via ajax and have them searchable.
|
* Loading data from JavaScript: easily load items via ajax and have them searchable.
|
||||||
@ -30,7 +29,7 @@ Browser compatibility
|
|||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
You can source Select2 directly from a CDN like [JSDliver][jsdelivr] or
|
You can source Select2 directly from a CDN like [JSDliver][jsdelivr] or
|
||||||
[CDNJS][cdnjs], [download it from this GitHub repo][tags], or use one of
|
[CDNJS][cdnjs], [download it from this GitHub repo][releases], or use one of
|
||||||
the integrations below.
|
the integrations below.
|
||||||
|
|
||||||
Integrations
|
Integrations
|
||||||
@ -105,7 +104,7 @@ The license is available within the repository in the [LICENSE][license] file.
|
|||||||
[bootstrap3-select2]: https://github.com/t0m/select2-bootstrap-css/tree/bootstrap3
|
[bootstrap3-select2]: https://github.com/t0m/select2-bootstrap-css/tree/bootstrap3
|
||||||
[cdnjs]: http://www.cdnjs.com/libraries/select2
|
[cdnjs]: http://www.cdnjs.com/libraries/select2
|
||||||
[django-select2]: https://github.com/applegrew/django-select2
|
[django-select2]: https://github.com/applegrew/django-select2
|
||||||
[documentation]: https://select2.github.io/select2/
|
[documentation]: https://select2.github.io/
|
||||||
[documentation-folder]: https://github.com/select2/select2/tree/master/docs
|
[documentation-folder]: https://github.com/select2/select2/tree/master/docs
|
||||||
[freenode]: https://freenode.net/
|
[freenode]: https://freenode.net/
|
||||||
[jsdelivr]: http://www.jsdelivr.com/#!select2
|
[jsdelivr]: http://www.jsdelivr.com/#!select2
|
||||||
@ -113,10 +112,10 @@ The license is available within the repository in the [LICENSE][license] file.
|
|||||||
[meteor-select2]: https://github.com/nate-strauser/meteor-select2
|
[meteor-select2]: https://github.com/nate-strauser/meteor-select2
|
||||||
[meteor-select2-alt]: https://jquery-select2.meteor.com
|
[meteor-select2-alt]: https://jquery-select2.meteor.com
|
||||||
[meteor-select2-bootstrap3]: https://github.com/esperadomedia/meteor-select2-bootstrap3-css/
|
[meteor-select2-bootstrap3]: https://github.com/esperadomedia/meteor-select2-bootstrap3-css/
|
||||||
|
[releases]: https://github.com/select2/select2/releases
|
||||||
[select2-rails]: https://github.com/argerim/select2-rails
|
[select2-rails]: https://github.com/argerim/select2-rails
|
||||||
[symfony-select2]: https://github.com/19Gerhard85/sfSelect2WidgetsPlugin
|
[symfony-select2]: https://github.com/19Gerhard85/sfSelect2WidgetsPlugin
|
||||||
[symfony2-select2]: https://github.com/avocode/FormExtensions
|
[symfony2-select2]: https://github.com/avocode/FormExtensions
|
||||||
[tags]: https://github.com/select2/select2/tags
|
|
||||||
[wicket]: http://wicket.apache.org
|
[wicket]: http://wicket.apache.org
|
||||||
[wicket-select2]: https://github.com/ivaynberg/wicket-select2
|
[wicket-select2]: https://github.com/ivaynberg/wicket-select2
|
||||||
[yii-select2]: https://github.com/tonybolzan/yii-select2
|
[yii-select2]: https://github.com/tonybolzan/yii-select2
|
||||||
|
Loading…
Reference in New Issue
Block a user