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?
- Check existing feature requests - Maybe the idea already exists
- Create an issue with the "enhancement" label
- 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
- Fork the Repository
Go to GitHub and click "Fork".
- Clone Your Fork
bash
git clone https://github.com/YOUR-USERNAME/bootstrap-intellisense.git
cd bootstrap-intellisense- Install Dependencies
bash
npm install- Open Project in VSCode
bash
code .- Start Extension in Debug Mode
- Press
F5or go to "Run > Start Debugging" - A new VSCode window (Extension Development Host) will open
- Test your changes in the new window
Workflow
- Create a Branch
bash
git checkout -b feature/your-feature-name
# or
git checkout -b fix/bug-description- Make Your Changes
- Write clean, well-documented code
- Follow existing code style
- Add tests if possible
Test Your Changes
Commit Your Changes
Push to GitHub
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:
- Click "Edit this page" on the respective docs page
- Make your changes
- Create a pull request
Larger Changes
- Fork the repository
- Navigate to
docs/ - Edit the Markdown files
- Test locally:
bash
npm run docs:dev- Create a pull request
Recognition
All contributors will be mentioned in our README. Your contribution is appreciated! 🎉
Questions?
If you have questions:
- 📧 Email: [email protected]
Thank You! 🙏
Thank you for considering contributing to Bootstrap IntelliSense. Every contribution, large or small, makes a difference!
