Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 4.09 KB

CONTRIBUTING.md

File metadata and controls

60 lines (47 loc) · 4.09 KB

RUTURO - BRoTM

RoTM by Team RUTURO – An Interactive Desktop Health Companion meticulously crafted for precise health monitoring and offering engaging mental health support in an affectionate manner.

  • RoTM - A Desktop Companion, crafted through advanced 3D technology, seamlessly integrates an array of electrical components, including motors,sensors and Microcontroller . This Companion is designed to intuitively comprehend user interactions across a spectrum of activities.

  • BRoTM, an Android / iOS app seamlessly connecting with RoTM . BRoTM lets you keep tabs on various health metrics throughout the day , Additionally, it furnishes you with weekly reports meticulously crafted around these key health metrics, offering a comprehensive and insightful snapshot of your well-being. (Cross platform app)

Contribution Guidelines for UI Improvement

Thank you for considering contributing to our app! We welcome your input to enhance user experience through UI improvements. To ensure a smooth and effective contribution process, please adhere to the following guidelines:

Purpose of Contributions

Our focus is on refining the user interface (UI) to improve usability, accessibility, and overall user experience. We encourage contributions that address UI-related issues, including but not limited to:

  • Design enhancements
  • Layout improvements
  • Color scheme adjustments
  • Typography modifications
  • Iconography updates
  • Responsiveness optimizations
  • Accessibility enhancements

Types of Contributions

Accepted contributions should primarily target UI improvements. These may include:

  • Bug fixes related to UI elements
  • User interface enhancements
  • Suggestions for better user interactions
  • Improvements to UI consistency across the app
  • Accessibility improvements within the UI
  • Feedback on existing UI elements and suggestions for enhancements

Contributions Not Accepted

While we appreciate all contributions, please note that we do not accept contributions related to:

  • Backend code or functionality
  • Non-UI related features or enhancements
  • Changes to database schemas or backend endpoints
  • Infrastructure modifications unrelated to UI improvements

Contribution Process

  1. Issue Identification: Before making any contributions, please review existing issues to ensure that your proposed improvement aligns with our goals. If you identify a UI-related issue that requires attention, consider contributing to its resolution.
  2. Proposal: If you have a new idea or suggestion for UI improvement, feel free to create a new issue outlining the problem and your proposed solution. Provide as much detail as possible to facilitate discussion and implementation.
  3. Code Submission: When submitting code for UI improvements, ensure that your changes are focused on the UI layer. Provide clear documentation and comments to help reviewers understand the purpose and implementation of your contribution.
  4. Review Process: All contributions will undergo review by our team to ensure alignment with our guidelines and standards. Feedback may be provided to refine the proposed changes before acceptance.
  5. Merge and Deployment: Once your contribution is approved, it will be merged into the main codebase and deployed in the next release cycle.

Code Standards and Guidelines

  • Follow established coding conventions and style guidelines.
  • Write clean, maintainable, and well-commented code.
  • Ensure compatibility with supported browsers and devices.
  • Test your changes thoroughly to avoid introducing regressions.

Community Etiquette

  • Be respectful and constructive when providing feedback or engaging in discussions.
  • Collaborate with other contributors to achieve the best possible outcomes.
  • Follow our code of conduct to maintain a positive and inclusive community environment.

By following these guidelines, you can help us create a more intuitive and user-friendly app interface. We appreciate your contributions and look forward to working together to enhance the user experience!

If you have any questions or need further clarification, please don't hesitate to reach out to our team.

Happy contributing! 🚀