On this page

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.

Issues

The issue tracker is a useful way to report bugs and request features. However, we do have some rules that you should follow;

  • Be civil and polite. It should be a welcoming place, ensuring nobody feels alienated.
  • Make sure your bug report or feature request doesn't already exist. This helps prevents duplication, if an issue already exists and you're able to provide more insight, feel free to comment on the existing issue.
  • Stick to the issue templates. These templates help us gather all the information needed to fix the issue or implement the feature.
  • Format any code snippets. If your bug report/feature request has any code snippets, please make sure you use code blocks to highlight and format your code.
  • Use screenshots & code examples where possible. This will further help us to understand what the bug or feature request is.

Labels

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).

Bug reports

Found a bug? Please open a bug report, however please try and take the following steps:

  • Make sure the bug hasn't already been reported. Search the issues (both open and closed).
  • Make sure the issue isn't with Select2:
    • Check the Select2 Github issues page to make sure it hasn't been reported there.
    • Disable the Select2 Bootstrap 5 Theme to see if the issue goes away or not.
  • Provide an example of the issue. Images are always helpful, however an example of the issue would be preferrable. Here's some tools that would help with this:

Feature requests

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:

  • Make sure the feature hasn't already been requested. Search the issues (both open and closed).
  • Make sure the feature is related to the styling. Functionality for Select2 cannot be altered, this theme simply styles it to fit with Bootstrap 5.

Pull requests

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:

  • Merge any changes from the master branch to ensure you have the latest version and prevent merge conflicts.
  • Run the compile scripts npm run compile and npm run docs:compile so that a compiled version is available.
  • Make sure the title and description are clear as to what was changed and why. Screenshots of the changes are welcome.
  • Tag any relevant issues so that we can easily see what the pull request relates to.

License

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.