Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
220 lines (152 loc) · 6.22 KB

CONTRIBUTING.md

File metadata and controls

220 lines (152 loc) · 6.22 KB

Contributing to VSCode+

First off, thank you for considering contributing to VSCode+! 🎉 It's people like you that make VS Code better for developers everywhere.

🌟 Our Mission

VSCode+ exists to transform VS Code into the ultimate polyglot IDE by providing ready-to-use configurations, extensions, and guides for every programming language. Every contribution helps developers spend less time configuring and more time coding.

🤝 How Can I Contribute?

1. Report Bugs or Issues

Found something not working? Let us know!

  • Use the Bug Report template
  • Check if the issue already exists
  • Include as much detail as possible (OS, VS Code version, language, etc.)
  • Add screenshots or error messages if applicable

2. Suggest New Features or Extensions

Have an idea? We'd love to hear it!

  • Use the Feature Request template
  • Explain the problem you're solving
  • Describe your proposed solution
  • Share any examples or references

3. Request a New Language

Need a language we don't support yet?

  • Use the Language Request template
  • Tell us which language and why
  • Share any essential extensions or tools
  • Volunteer to help if you're experienced!

4. Improve Documentation

Documentation can always be better!

  • Fix typos or unclear explanations
  • Add examples or clarifications
  • Update outdated information
  • Translate content (coming soon!)

5. Contribute Code/Configurations

Ready to add value? Amazing!

  • Add new extensions to recommendations
  • Improve settings configurations
  • Create or enhance dev containers
  • Write automation scripts
  • Add examples and tutorials

📋 Contribution Guidelines

Before You Start

  1. Search existing issues/PRs - Someone might already be working on it
  2. Open an issue first - Discuss significant changes before implementing
  3. One feature per PR - Keep pull requests focused and manageable
  4. Follow the structure - Each repo has a consistent layout

Pull Request Process

  1. Fork the repository you want to contribute to
  2. Create a branch with a descriptive name:
    • feature/add-python-debugging-config
    • fix/typescript-settings-typo
    • docs/improve-setup-guide
  3. Make your changes:
    • Follow existing code/config style
    • Test your changes thoroughly
    • Update documentation if needed
  4. Commit with clear messages: 
    Add Pylint configuration for Python

- Added .pylintrc with sensible defaults
- Updated settings.json with Pylint integration
- Added documentation in docs/LINTING.md
  5. Push to your fork and submit a pull request
  6. Fill out the PR template completely
  7. Respond to feedback - We'll review and may request changes

Code Review Process

  • Maintainers will review PRs within 3-5 business days
  • We may request changes or clarifications
  • Once approved, a maintainer will merge your PR
  • Your contribution will be credited in release notes!

🎨 Style Guidelines

Configuration Files

  • Use consistent formatting (2-space indentation for JSON)
  • Add comments explaining non-obvious settings
  • Group related settings together
  • Keep platform-specific settings in separate sections

Documentation

  • Write in clear, simple English
  • Use headings and bullet points for readability
  • Include code examples where helpful
  • Add screenshots for UI-related instructions
  • Use emoji sparingly and consistently ✅

Markdown

  • Follow standard Markdown formatting
  • Use relative links for internal references
  • Keep lines under 120 characters when possible
  • Use code blocks with language specification

🔍 Testing Your Contributions

For Configuration Changes

  1. Test in a fresh VS Code profile/workspace
  2. Verify extensions install correctly
  3. Check that settings don't conflict
  4. Test on different platforms if possible (Windows, Mac, Linux)

For Documentation

  1. Check for spelling and grammar
  2. Verify all links work
  3. Test any commands or code examples
  4. Ensure formatting renders correctly

For Dev Containers

  1. Build the container successfully
  2. Verify all tools are installed
  3. Test with sample code
  4. Document any prerequisites

🏷️ Issue and PR Labels

We use labels to organize and prioritize work:

  • bug - Something isn't working
  • enhancement - New feature or request
  • documentation - Documentation improvements
  • good first issue - Great for newcomers
  • help wanted - Extra attention needed
  • language: python - Python-specific (same for other languages)
  • priority: high - Urgent issues
  • wontfix - Won't be addressed

💬 Community Guidelines

Be Respectful

  • Treat everyone with respect and kindness
  • Welcome newcomers and help them learn
  • Assume good intentions
  • Provide constructive feedback

Be Collaborative

  • Share knowledge and resources
  • Give credit where it's due
  • Work together to solve problems
  • Celebrate each other's contributions

Be Professional

  • Keep discussions on-topic
  • Use appropriate language
  • Respect different opinions and approaches
  • Follow the Code of Conduct

🎯 Recognition

Contributors are the heart of VSCode+:

  • All contributors are listed in repository release notes
  • Significant contributions may be highlighted on our profile
  • Active contributors may be invited to join as maintainers
  • We'll give you proper credit and thanks!

📞 Getting Help

Need help contributing?

  • 💬 Discussions - Ask questions and share ideas
  • 📧 Maintainers - Tag us in issues or PRs
  • 📖 Documentation - Check our guides and examples
  • 🌐 Community - Connect with other contributors

🚀 What Happens Next?

After your contribution is merged:

  1. It will be included in the next release
  2. Other users will benefit from your work
  3. You'll be credited as a contributor
  4. You'll have made VS Code better for everyone!

📜 License

By contributing, you agree that your contributions will be licensed under the same license as the repository (typically MIT License).

Thank you for making VSCode+ better! 🙌

Every contribution, no matter how small, helps developers around the world.