Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
216 lines (156 loc) · 6.77 KB

CONTRIBUTING.md

File metadata and controls

216 lines (156 loc) · 6.77 KB
Raw

Contributing to Honeymelon

Thank you for your interest in contributing to Honeymelon! 🍈

Honeymelon is free and open-source software licensed under GPL v3, and we welcome community contributions of all kinds!

This repository is primarily for bug reports, feature requests, and community discussions. For code contributions, please visit the main Honeymelon repository.

How You Can Contribute

1. Report Bugs

Found a bug? Help us fix it!

  1. Check if the bug has already been reported in Issues
  2. If not, create a new bug report
  3. Fill out all required fields in the template
  4. Provide detailed steps to reproduce the issue
  5. Include your macOS version, chip type, and app version

Good bug reports include:

  • Clear, descriptive title
  • Detailed reproduction steps
  • Expected vs. actual behavior
  • System information (macOS version, chip, app version)
  • Logs, screenshots, or screen recordings
  • Workarounds you've tried

2. Request Features

Have an idea to make Honeymelon better?

  1. Check existing feature requests
  2. If your idea is new, create a feature request
  3. Explain the problem your feature would solve
  4. Describe your proposed solution
  5. Consider alternatives and edge cases

Good feature requests include:

  • Clear use case or problem statement
  • Detailed description of proposed solution
  • Examples or mockups (if applicable)
  • Consider how it fits with existing features

3. Participate in Discussions

Join the conversation!

  1. Browse Discussions
  2. Share your experiences and workflows
  3. Help other users with questions
  4. Vote on feature requests and ideas
  5. Provide feedback on proposed changes

4. Improve Documentation

Help make our documentation better:

  1. Report unclear or missing documentation
  2. Suggest improvements to support materials
  3. Share tips and tricks in discussions
  4. Help answer common questions

5. Spread the Word

Support the project by:

  • Sharing Honeymelon with others who might benefit
  • Writing blog posts or tutorials about your workflow
  • Sharing feedback about what works well
  • Starring the project on GitHub

Issue Triage and Labels

Understanding Labels

We use labels to categorize and prioritize issues:

Type Labels:

  • bug - Something isn't working
  • enhancement - New feature or request
  • question - Further information is requested
  • documentation - Improvements or additions to documentation

Priority Labels:

  • priority: critical - Crashes, data loss, security issues
  • priority: high - Significant impact on functionality
  • priority: medium - Moderate impact
  • priority: low - Minor issues or nice-to-have features

Status Labels:

  • status: needs-triage - Awaiting team review
  • status: needs-info - Waiting for more information
  • status: confirmed - Issue verified and accepted
  • status: in-progress - Actively being worked on
  • status: blocked - Cannot proceed due to dependencies

Platform Labels:

  • macos-version: sonoma - Specific to macOS 14 Sonoma
  • macos-version: ventura - Specific to macOS 13 Ventura
  • macos-version: monterey - Specific to macOS 12 Monterey
  • chip: apple-silicon - Apple M1/M2/M3/M4 specific
  • chip: intel - Intel processor specific

Other Labels:

  • duplicate - This issue already exists
  • wontfix - Will not be addressed
  • license - Related to licensing or activation
  • good-first-issue - Good for newcomers

See TRIAGE.md for detailed triage guidelines.

Communication Guidelines

Be Respectful

  • Treat everyone with respect and kindness
  • Follow our Code of Conduct
  • Assume good intentions
  • Be patient with responses

Be Clear and Concise

  • Use descriptive titles for issues
  • Write clear descriptions
  • Break down complex issues into steps
  • Use formatting (code blocks, lists, etc.)

Be Constructive

  • Focus on solutions, not just problems
  • Provide context and examples
  • Acknowledge others' efforts
  • Offer to help test or verify fixes

Be Patient

  • The team reviews issues regularly but may not respond immediately
  • Bug fixes and features are prioritized based on impact and resources
  • Some features may not align with the product vision
  • Providing more information helps us respond faster

Issue Lifecycle

  1. Submitted: New issue created
  2. Needs Triage: Awaiting team review
  3. Triaged: Labeled, prioritized, and acknowledged
  4. Needs Info: Waiting for reporter to provide additional details
  5. Confirmed: Verified and accepted
  6. In Progress: Being actively worked on
  7. Resolved: Fixed in a release (issue closed with reference to version)
  8. Closed: Completed, duplicate, cannot reproduce, or won't fix

What We Look For

In Bug Reports

✅ Detailed reproduction steps ✅ Complete system information ✅ Expected vs. actual behavior ✅ Logs and diagnostic information ✅ Screenshots or recordings ✅ Workarounds attempted

❌ Vague descriptions ❌ Missing system information ❌ "It doesn't work" without details ❌ Multiple unrelated issues in one report

In Feature Requests

✅ Clear problem statement ✅ Proposed solution ✅ Use cases and examples ✅ Consideration of alternatives ✅ How it benefits users

❌ Vague wishes without context ❌ Demands without rationale ❌ Features that conflict with app vision ❌ Duplicate requests without new insights

Response Times

  • Security issues: 24-48 hours
  • Critical bugs: 1-3 business days
  • Standard issues: 3-7 business days
  • Feature requests: 1-2 weeks for initial review
  • Discussions: Community-driven

Getting Your Issue Resolved Faster

  1. Search first: Check if it's already reported
  2. Follow templates: Fill out all fields
  3. Provide details: More info = faster resolution
  4. Be responsive: Reply to requests for information
  5. Test betas: Help verify fixes in pre-release versions
  6. One issue per report: Don't combine multiple problems

Code of Conduct

Please note that this project follows our Code of Conduct. By participating, you agree to abide by its terms.

Questions?

License

By contributing to this repository (through issues, discussions, or other means), you agree that your contributions will be available under the same MIT License that covers this repository.

Thank you for contributing to Honeymelon! Your feedback and participation help make the app better for everyone. 🍈