diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..872d86d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +Angular Dual-Listbox +========= + +### Contributions + +Bug reports and feature requests are best directed to the project's +[issues](https://github.com/czeckd/angular-dual-listbox/issues) page. + +## Bugs +Please make sure you're using the latest version of `angular-dual-listbox` before opening an issue. +Providing a use case, sample app, code gist, or steps to reproduce the problem make it more likely a +fix will be found. + +Forking this project or using the +[custom-dual-listbox](https://github.com/czeckd/custom-dual-listbox) seed project as a basis for +reproducing the issue is a good starting place. Please include code or a link to your git repository +in your issue. + +## Feature requests + +New features may be added depending on the impact on the core functionality of the project. +Specialization or corner cases, however, are best handled by a fork. + + +### Submissions + +In order for pull requests to be accepted, they must include a sign-off in git (See [git-commit +--signoff](https://git-scm.com/docs/git-commit)) certifying the contribution is your own work, are +subitting under the project's original license, and agreeing to the [Developer Certificate of +Origin](https://developercertificate.org/). + diff --git a/README.md b/README.md index 1a3e162..b61ee35 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,10 @@ Angular Dual-Listbox ========= -The **angular-dual-listbox** is an Angular 2+ component that provides two lists controls side-by-side that allows items in one list to be moved to the other list via drag-and-drop and/or a button-based interface. -The component supports multiple select options from the list, programatic setting of list sources, and layout with direction and button formatting. +The **angular-dual-listbox** is an Angular 4+ component that provides two lists controls +side-by-side that allows items in one list to be moved to the other list via drag-and-drop and/or a +button-based interface. The component supports multiple select options from the list, programatic +setting of list sources, and layout with direction and button formatting. A [working demo](http://czeckd.github.io/angular-dual-listbox/demo/) shows the dual listbox in action. @@ -71,12 +73,6 @@ The drag-and-drop between multiple ```` components may cause undesired moves. For the time being, if the component is used, then it is recommended only have one ```` visable to the user at a time. -## Contributions - -Contributions may be welcomed depending on impact on the core functionality of the project. In order for pull requests to be accepted, they must include a sign-off in git (See [git-commit ---signoff](https://git-scm.com/docs/git-commit)) certifying the contribution is your own work, are subitting under the project's original license, and agreeing to the [Developer Certificate of -Origin](https://developercertificate.org/). - ## License MIT