Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.89 KB

Contributing to HORUS

We welcome and appreciate community involvement in the HORUS project. As this is part of an ongoing PhD research, contributions are managed in a specific way.

Ways to Contribute

  1. Using the Application: The most valuable contribution is to use the HORUS application and provide feedback.

  2. Reporting Issues: If you encounter any problems or bugs while using HORUS, please open an issue on our GitHub repository. Describe the problem in detail, including steps to reproduce it, and any relevant environment information.

  3. Suggesting Features: If you have ideas for new features that are not currently in our roadmap, please open an issue to suggest them. Explain the feature and provide justification for why it would be beneficial to the project.

  4. Code Contributions: Due to the nature of this project as part of PhD research, direct code contributions require prior discussion and approval. If you're interested in contributing code:

    • Email Omotoye Shamsudeen Adekoya at omotoye.adekoya@edu.unige.it
    • Briefly describe your proposed contribution and your relevant experience
    • Wait for a response to discuss the contribution and initiate the process of granting you access to the main codebase.

Issue Reporting Guidelines

When opening an issue, please provide:

  • A clear and descriptive title
  • A detailed description of the issue or suggestion
  • Steps to reproduce (for bugs)
  • Expected behavior
  • Actual behavior
  • Screenshots (if applicable)
  • Your environment (Meta Quest firmware version, Meta Quest type etc.)

Feature Suggestion Guidelines

When suggesting a new feature:

  • Explain the feature in detail
  • Describe the use case(s) for this feature
  • Explain how this feature aligns with HORUS's goals
  • If possible, outline potential implementation approaches

We appreciate your understanding and look forward to your feedback and ideas to improve HORUS!