Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (47 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

81 lines (47 loc) · 2.38 KB

Contributing to Hyperactive

Thank you for your interest in contributing to Hyperactive. This project values self-directed contributors who bring their own ideas and experiences to the table.

Before You Contribute

The best contributions come from people who actively use the library. Before contributing, we recommend:

  • Use Hyperactive in your own projects - Hands-on experience helps you identify real problems and useful improvements
  • Explore the codebase - Understand the architecture and design decisions
  • Read existing issues and discussions - Get familiar with ongoing conversations and past decisions

Ways to Contribute

Feedback and Discussions

  • Upvote issues that are important to you
  • Share your use cases - How are you using Hyperactive? What works well?
  • Participate in discussions - Your domain expertise can help shape the project

Opening Issues

Bug Reports

If you encounter a bug while using Hyperactive:

  1. Search existing issues to avoid duplicates
  2. Use the bug report template
  3. Include a minimal reproducible example
  4. Describe what you expected vs. what happened

Feature Requests

Feature requests are most valuable when they come from real usage experience:

  1. Describe the problem you're trying to solve
  2. Explain your current workaround (if any)
  3. Suggest a solution if you have one in mind

Questions

Before asking a question:

  1. Check the documentation
  2. Search existing issues and discussions
  3. If still unclear, open an issue with specific details

Pull Requests

Before Starting

  • Discuss first - Open an issue to discuss your idea before writing code
  • One change per PR - Keep pull requests focused on a single improvement

When Submitting

  • Understand the code you're changing - Be prepared to explain your changes and their implications
  • Test thoroughly - Verify your changes work as intended
  • Explain the "why" - Help reviewers understand the reasoning behind your changes

PR Format

  • Use tags in the title: [Fix], [Feature], [Refactor], [Docs]
  • Link to the related issue
  • Describe what changed and why

Code Style

  • Follow the existing code style in the repository
  • Run the test suite before submitting
  • Keep commits focused and well-described

Code of Conduct

Please be respectful in all interactions. We're all here to build something useful together.