--- layout: default title: Contributing permalink: /about/contributing/ ---
Find out how you can contribute to the Select2 Bootstrap 5 theme with bug reports, feature requests and pull requests.
Please follow these guidelines in order to keep the process simple and prevent any possible confusions.
The issue tracker is a useful way to report bugs and request features. However, we do have some rules that you should follow;
The bug tracker utilises several labels in order to organise and identify all issues submitted. Here's what labels we currently use;
Label | Use |
---|---|
bug |
Bug reports that need to be fixed. |
dependencies |
Issues stemming from, or that will alter, any dependencies used. |
documentation |
Issues that require documentation to be changed. |
duplicate |
Issues that have already been created, these issues get closed and linked to the original issue. |
enhancement |
Feature requests that need to be implemented. |
help wanted |
Issues we need some help in resolving. |
on hold |
Issues that will be tackled at a later date, a reason should always be given in the comments. |
pending release |
The issue has been resolved, but is pending release in the next version. |
question |
More information is needed on these issues. |
wontfix |
Issues that are out of our remit (e.g. issues related to Bootstrap or Select2) or non-issues (e.g. support requests). |
Found a bug? Please open a bug report, however please try and take the following steps:
Got an idea to expand the functionality? Feel free to submit a feature request, or fork the repo and submit a pull request. If you're submitting a feature request, please be aware of the following:
Fixed a bug or implemented a new feature? Please submit a pull request to the repo so we can include it in the theme. Please be aware of the following when submitting a pull request:
master
branch to ensure you have the latest version and prevent merge conflicts.npm run compile
and npm run docs:compile
so that a compiled version is available.By contributing, you agree that your code falls under the MIT License.
By contributing to the documentation, you agree that your contribution falls under the Creative Commons Attribution 4.0 International Public License.