Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (78 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

123 lines (78 loc) · 3.51 KB

Contributing to Pointbreak

Thank you for your interest in Pointbreak!

Pointbreak is free, but it's not currently Open Source Software. The source code is not publicly available at this time.

However, at this early stage, your feedback is highly valued in helping shape the future of the project. You can contribute in the following ways:

How You Can Contribute

🐛 Report Bugs

Found a bug? Help us fix it by filing a detailed bug report.

Before reporting:

  1. Check existing issues to avoid duplicates
  2. Try reproducing the issue with the latest version
  3. Gather relevant information (OS, VS Code version, debug adapter, etc.)

To report a bug:

  • Use the Bug Report template
  • Provide clear steps to reproduce
  • Include error messages, logs, and screenshots if applicable
  • Describe expected vs actual behavior

💡 Request Features

Have an idea for improving Pointbreak? Would love to hear it!

To request a feature:

  • Use the Feature Request template
  • Describe the problem you're trying to solve
  • Explain how you envision the feature working
  • Share use cases and examples

💬 Join Discussions

Share your experiences, ask questions, and engage with the community.

Discussion topics:

  • Use cases and workflows
  • Integration ideas
  • Questions about functionality
  • Best practices
  • Tips and tricks

Visit GitHub Discussions to join the conversation.

📝 Improve Documentation

Help make documentation clearer and more useful.

Ways to help:

  • Suggest improvements to existing docs
  • Point out confusing sections
  • Share examples and use cases
  • Identify missing documentation

File documentation suggestions as issues with the "documentation" label.

Issue Etiquette

When filing issues:

✅ Do:

  • Be respectful and constructive
  • Provide detailed information
  • Stay on topic
  • Follow up on questions
  • Search before posting

❌ Don't:

  • Demand features or fixes
  • Post "+1" or "me too" comments (use reactions instead)
  • Open duplicate issues
  • Go off-topic in issue threads
  • Share sensitive information (API keys, passwords, etc.)

Security Issues

Do not file public issues for security vulnerabilities.

See SECURITY.md for instructions on privately reporting security issues.

Response Times

The goal:

  • Acknowledge new issues within 3 business days
  • Provide initial feedback on feature requests within 1 week
  • Fix critical bugs in the next release

Please be patient.

Code of Conduct

All community members should:

  • Be respectful and inclusive
  • Welcome newcomers
  • Focus on constructive feedback
  • Respect differing opinions
  • Report inappropriate behavior

Harassment, trolling, and abusive behavior will not be tolerated.

Questions?

Thank You!

We appreciate your interest in making Pointbreak better. Every bug report, feature request, and piece of feedback helps improve the product for everyone.