Skip to content

Latest commit

 

History

History
66 lines (56 loc) · 3.55 KB

pull_request_template.md

File metadata and controls

66 lines (56 loc) · 3.55 KB

[Insert URL to your proposal here]

[Explain what this proposal is about and why it should be included here]

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Requirements for your pull request

  • Don't open a Draft / WIP pull request while you work on the guidelines. A proposal should be well-thought-out and complete when you open it.
  • You have to review at least 2 other open proposals.
    • Focus on technical feasibility and potential implementation challenges
    • Suggest improvements or alternative approaches
    • Simply commenting "looks good" does not count
    • Comment here which proposals you reviewed
  • This pull request has a title in the format Propose Name of Feature/Tool.
    • ✅ propose: Cross-Platform Package Manager
    • ✅ propose: Universal Code Translator
    • ❌ Propose Universal Code Translator
    • ❌ Update readme.md
    • ❌ Add new idea
    • ❌ New feature proposal
  • Your entry should include a short description of the proposed feature/tool. It should explain the core functionality, not just list benefits. The first character should be uppercase and the description should end in a dot.
    • ✅ - [Universal Debugger](…) - A debugging tool that works across all programming languages using common debugging patterns.
    • ✅ - [AI Test Generator](…) - Automatically generates comprehensive test suites by analyzing code behavior and intent.
    • ❌ - [Better IDE](…) - A really cool IDE that makes coding easier.
    • ❌ - [Code Helper](…)
  • Your entry should be added to the appropriate category based on development stage:
    • 🌱 Concept Stage
    • 💭 Under Discussion
    • 🛠️ In Development
    • ✨ Partially Implemented

Requirements for your Wishlist proposal

  • Includes a clear problem statement and solution overview at the top of the proposal.
  • The repo name should be in lowercase slug format: wishlist-name-of-feature.
  • The proposal includes:
    • Detailed description of the problem being solved
    • Technical implementation approach
    • Required technologies or dependencies
    • Potential challenges and limitations
    • Use cases and target users
    • Similar existing tools or partial solutions (if any)
  • Has a Table of Contents section named Contents.
  • Includes the Wishlist badge.
  • Has an appropriate license (preferably CC0).
  • Has contribution guidelines for others to help refine the proposal.
  • Contains mockups, diagrams, or prototypes when applicable.
  • Clearly explains why existing solutions (if any) are inadequate.
  • Has consistent formatting and proper spelling/grammar.
  • Includes a technical feasibility assessment.
  • Specifies required resources or skills needed for implementation.
  • To verify that you've read all the guidelines, please comment on your pull request with just the word innovation.

Proposal Status Labels

Your proposal should include one of these status labels:

  • 🌱 concept - Initial idea stage
  • 💭 discussion - Under active discussion/refinement
  • 🛠️ development - Someone is working on it
  • ✨ partial - Partially implemented
  • ✅ completed - Successfully implemented (move to awesome list)

Go to the top and read it again.