Skip to content

Contributing ​

Thank you for your interest in contributing to Bootstrap IntelliSense! Contributions of all kinds are welcome.

How You Can Contribute ​

There are many ways to contribute to the project:

  • 🐛 Report Bugs - Help us find and fix bugs
  • 💡 Suggest Features - Share your ideas for new features
  • 📝 Improve Documentation - Help make the docs clearer
  • 💻 Contribute Code - Implement new features or fix bugs
  • ⭐ Support the Project - Give us a star on GitHub

Reporting Bugs ​

If you've found a bug:

Creating an Issue ​

Go to GitHub Issues (navigate to /issues) and create a new issue.

Suggesting Features ​

Have an idea for a new feature?

  1. Check existing feature requests - Maybe the idea already exists
  2. Create an issue with the "enhancement" label
  3. Describe:
    • What the feature should do
    • Why it would be useful
    • How it could work (optional)
    • Mockups or examples (if available)

Contributing Code ​

Setting Up Development Environment ​

Prerequisites ​

  • Node.js (version 16 or higher)
  • npm or yarn
  • Visual Studio Code
  • Git

Setup ​

  1. Fork the Repository

Go to GitHub and click "Fork".

  1. Clone Your Fork
bash
git clone https://github.com/YOUR-USERNAME/bootstrap-intellisense.git
cd bootstrap-intellisense
  1. Install Dependencies
bash
npm install
  1. Open Project in VSCode
bash
code .
  1. Start Extension in Debug Mode
  • Press F5 or go to "Run > Start Debugging"
  • A new VSCode window (Extension Development Host) will open
  • Test your changes in the new window

Workflow ​

  1. Create a Branch
bash
git checkout -b feature/your-feature-name
# or
git checkout -b fix/bug-description
  1. Make Your Changes
  • Write clean, well-documented code
  • Follow existing code style
  • Add tests if possible
  1. Test Your Changes

  2. Commit Your Changes

  3. Push to GitHub

  4. Create a Pull Request

Documentation ​

  • Update README and Changelog if necessary
  • Document new configuration options
  • Add examples

Improving Documentation ​

Documentation is just as important as code!

Typos or Small Corrections ​

For small changes:

  1. Click "Edit this page" on the respective docs page
  2. Make your changes
  3. Create a pull request

Larger Changes ​

  1. Fork the repository
  2. Navigate to docs/
  3. Edit the Markdown files
  4. Test locally:
bash
npm run docs:dev
  1. Create a pull request

Recognition ​

All contributors will be mentioned in our README. Your contribution is appreciated! 🎉

Questions? ​

If you have questions:

Thank You! 🙏 ​

Thank you for considering contributing to Bootstrap IntelliSense. Every contribution, large or small, makes a difference!

Made with ❤