Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (45 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 2.67 KB

Contributing to Piano Fitness App

Thank you for your interest in contributing to the Piano Fitness App. We value input from our community and appreciate your help in making this application better for piano students and teachers worldwide.

Code of Conduct

In the interest of fostering an open and welcoming environment, we expect all participants in our project to treat each other with respect and professionalism. We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.

Reporting Issues

When reporting issues, please include the following information to help us understand and address the problem effectively:

  1. A clear and descriptive title
  2. A detailed description of the issue, including:
    • What you were trying to do
    • What you expected to happen
    • What actually happened
  3. Steps to reproduce the issue
  4. Your environment details:
    • Device type and model
    • Operating system and version
    • MIDI keyboard make and model
    • Connection method (USB, Bluetooth, USB OTG)
  5. Screenshots or recordings if applicable
  6. Any relevant error messages or logs

Suggesting Enhancements

We welcome suggestions for enhancing the Piano Fitness App. When submitting feature requests, please provide:

  1. A clear and descriptive title
  2. A detailed explanation of the proposed feature, including:
    • The problem it solves or need it addresses
    • How it would benefit piano students or teachers
    • Any potential drawbacks or considerations
  3. Examples of similar features in other applications, if applicable
  4. Any relevant research or educational principles that support the feature
  5. Mock-ups or diagrams if they would help explain the concept

Pull Requests

Development guidelines and instructions for submitting pull requests will be added in a future update. For now, please focus on submitting issues and feature requests to help us improve the application.

Communication

When participating in discussions:

  1. Use clear and professional language
  2. Provide constructive feedback
  3. Stay focused on improving the application
  4. Be patient with other contributors
  5. Ask for clarification when needed

Questions and Support

If you have questions about contributing or need support:

  1. Check existing issues and discussions first
  2. Ensure your question hasn't already been addressed
  3. Use clear and specific titles for new questions
  4. Provide relevant context and details

Thank you for helping make the Piano Fitness App better for everyone.