Nov 19, 2024

How to Create Issues and Propose Features on Our GitHub Repositories

A Guide to Shaping Reality AI Lab’s Projects

Welcome to our open-source community! Whether you're reporting a bug, suggesting improvements, or proposing a new feature, your contributions help shape the future of our projects. This guide outlines everything you need to know about creating issues and submitting feature proposals on our GitHub repositories.

Understanding Our GitHub Repositories

We maintain two key repositories for our projects:

  1. marvel-platform: This is the primary repository for contributions.
  2. marvel-ai-backend: Focused on backend development.

Both repositories are linked to our shared Issue Board Project, making it easier to track tasks across the platform.

Choosing the Right Repository

  • Default Option: If unsure, create your issue in the marvel-platform repository.
  • Specific Issues: For AI backend-related problems, use the marvel-ai-backend repository.
  • No Worries: Our moderators can move issues to the correct repository if needed.

Steps for Submitting Issues and Proposals

1. Research Your Idea

Before creating an issue, consider the following:

  • Check Existing Issues: Review the repository’s open issues to see if someone has already reported or proposed your idea.
  • Test Current Features: Verify functionality to ensure your feedback is relevant and actionable.
  • Align with Our Mission: Ensure your suggestion supports our focus on education, career development, and ethical AI.

2. Use GitHub Issue Templates

We’ve designed templates to make submitting issues easier and more efficient. Select the one that best matches your needs:

  1. Bug Report: To report problems or errors.
  2. Feature Request: To propose new ideas.
  3. Suggest an Improvement: To enhance existing features.

Why Templates Matter

  • Clarity: They guide you to include essential details.
  • Efficiency: Well-filled templates help maintainers act quickly.
  • Consistency: They keep our issue tracking organized.

3. Fill Out the Template

Each template is tailored to specific issue types. Here’s what to include:

Bug Report

  • Describe the Bug: What’s the issue?
  • To Reproduce: Steps to replicate the problem.
  • Expected Behavior: What should happen instead?
  • Screenshots: Images to illustrate the problem.
  • System Info: Your OS, browser, and versions.
  • Additional Context: Any other relevant details.

Feature Request

  • Problem Statement: What problem does your idea solve?
  • Proposed Solution: Describe your idea clearly.
  • Expected Impact: How will it benefit users or contributors?
  • Additional Context: Mockups, links, or diagrams.

Suggest an Improvement

  • Feature to Improve: Name and describe it.
  • Problem Addressed: Why is the improvement needed?
  • Proposed Solution: Explain your suggested enhancement.
  • Alternatives Considered: Other options you’ve thought of.

Engaging with the Community

Once you’ve submitted your issue:

  1. Monitor Feedback: Stay responsive to comments or questions.
  2. Join Discussions: Share your idea on forums on the Reality AI Platform.
  3. Collaborate: Work with other contributors to refine your proposal.

Tips for Success

  • Be Clear and Concise: Avoid vague requests like "Make it better." Use specific examples.
  • Focus on Users: Explain how your idea benefits educators, learners, or developers.
  • Support with Materials: Attach screenshots, diagrams, or mockups.
  • Stay Open to Feedback: Be ready to revise based on community input.
  • Collaborate: Partner with maintainers to align your idea with project priorities.

After Submitting an Issue

Once submitted, your issue will undergo the following process:

  1. Moderation: A moderator reviews it for completeness and relevance.
  2. Triage: Issues are prioritized based on impact and feasibility.
  3. Review Outcomes:
    • Approved: Added to the roadmap or GitHub project board.
    • Deferred: Valuable but scheduled for later.
    • Rejected: Not aligned with project goals.

Frequently Asked Questions (FAQs)

Q: Can I start coding before my proposal is approved?

A: It’s better to wait for approval to ensure alignment with project priorities. However, draft implementations are welcome to illustrate your idea.

Q: How long does it take to review a proposal?

A: Review timelines vary. Simple issues may take days, while complex ones can take weeks.

Q: Do I need technical expertise to contribute?

A: Not at all! Non-technical contributors are encouraged to focus on problems and desired outcomes.

Ready to Get Started?

Your ideas fuel innovation in our open-source projects. Whether you're reporting a bug or proposing a game-changing feature, your contribution makes a difference.

Start by creating an issue on our GitHub repositories or joining the discussion on our forums.

Happy Contributing!

‍

Explore our collection of 200+ Premium Webflow Templates