Recommend this page to a friend! |
Classes of Jorge Castro | Gentelella BladeOne | vendors/select2/CONTRIBUTING.md | Download |
|
DownloadContributing to Select2Looking to contribute something to Select2? Here's how you can help. Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features. Using the issue trackerWhen [reporting bugs][reporting-bugs] or [requesting features][requesting-features], the [issue tracker on GitHub][issue-tracker] is the recommended channel to use. The issue tracker is not a place for support requests. The [mailing list][community] or [IRC channel][community] are better places to get help. Reporting bugs with Select2We really appreciate clear bug reports that _consistently_ show an issue _within Select2_. The ideal bug report follows these guidelines:
Please try to be as detailed as possible in your bug report, especially if an isolated test case cannot be made. Some useful questions to include the answer to are:
All of these questions will help others fix and identify any potential bugs. Requesting features in Select2Select2 is a large library that carries with it a lot of functionality. Because of this, many feature requests will not be implemented in the core library. Before starting work on a major feature for Select2, contact the [community][community] first or you may risk spending a considerable amount of time on something which the project developers are not interested in bringing into the project. Contributing changes to Select2Select2 is made up of multiple submodules that all come together to make the standard and extended builds that are available to users. The build system uses Node.js to manage and compile the submodules, all of which is done using the Grunt build system. Installing development dependenciesSelect2 can be built and developed on any system which supports Node.js. The preferred Node.js version is 0.10, but 0.12 and later versions can be used without any noticeable issues. You can download Node.js at [their website][nodejs]. All other required Node.js packages can be installed using [npm][npm], which comes bundled alongside Node.js.
You may need to install libsass on your system if it is not already available in order to build the SASS files which generate the CSS for themes and the main component. In order to build and serve the documentation, you need to have [Jekyll][jekyll] installed on your system. Building the Select2 componentSelect2 uses the [Grunt][grunt] build task system and defines a few custom
tasks for common routines. One of them is the
You can also generate the minified versions (
Building the documentationUsing the Grunt build system, you run Jekyll and serve the documentation locally. This will also set up the examples to use the latest version of Select2 that has been built.
Running testsSelect2 uses the QUnit test system to test individual components.
Submitting a pull requestWe use GitHub's pull request system for submitting patches. Here are some guidelines to follow when creating the pull request for your fix.
By following these steps, you will make it easier for your pull request to be reviewed and eventually merged. Triaging issues and pull requestsAnyone can help the project maintainers triage issues and review pull requests. Handling new issuesSelect2 regularly receives new issues which need to be tested and organized. When a new issue that comes in that is similar to another existing issue, it
should be checked to make sure it is not a duplicate. Duplicates issues should
be marked by replying to the issue with "Duplicate of #[issue number]" where
If you can test issues that are reported to Select2 that contain test cases and confirm under what conditions bugs happen, that will allow others to identify what causes a bug quicker. Reviewing pull requestsIt is very common for pull requests to be opened for issues that contain a clear solution to the problem. These pull requests should be rigorously reviewed by the community before being accepted. If you are not sure about a piece of submitted code, or know of a better way to do something, do not hesitate to make a comment on the pull request. Reviving old ticketsIf you come across tickets which have not been updated for a while, you are
encouraged to revive them. While this can be as simple as saying LicensingIt should also be made clear that all code contributed to Select must be licensable under the [MIT license][licensing]. Code that cannot be released under this license cannot be accepted into the project. [community]: https://select2.github.io/community.html [grunt]: http://gruntjs.com/ [isolated-case]: http://css-tricks.com/6263-reduced-test-cases/ [issue-search]: https://github.com/select2/select2/search?q=&type=Issues [issue-tracker]: https://github.com/select2/select2/issues [jekyll]: https://jekyllrb.com/docs/installation/ [licensing]: https://github.com/select2/select2/blob/master/LICENSE.md [nodejs]: https://nodejs.org/ [npm]: https://www.npmjs.com/ [reporting-bugs]: #reporting-bugs-with-select2 [requesting-features]: #requesting-features-in-select2 |