Skip to content

Latest commit

 

History

History
91 lines (57 loc) · 3.47 KB

wishlist.md

File metadata and controls

91 lines (57 loc) · 3.47 KB

The Wishlist Manifesto

Wishlists are filling a gap in the open source ecosystem by creating a standardized way to propose and track feature ideas that don't have a natural "home" in existing projects:

Web → Scattered Wishes → Wishlist → Implementation → Awesome

If you want your idea to be included in this wishlist, try to only include genuinely innovative and feasible concepts. This is a curated collection of thoughtful proposals, not a dumping ground for random ideas.

But what makes a good wishlist item?

Only well-thought-out ideas are worth including

Research if your proposed feature or tool could actually be developed with current or near-future technology. Only suggest items that you can thoroughly explain and justify. It's better to have fewer high-quality proposals than many vague wishes.

Wishlist badge

This badge is for Wishlists.

Wishlist

[![Wishlist](https://badge.wishlist.sh)](https://wishlist.sh)

Add this wishlist badge to the top of your list, right next to the title.
Alternatively include it in an 'a' tag, for example:

<a href="https://wishlist.sh">
    <img src="https://badge.wishlist.sh" alt="Wishlist">
</a>

You are allowed to use the badge on lists not included here and also on private lists.

The badges should not be modified in any way.

Explain why it should exist

Apart from describing your proposed tool or feature, you should also explain:

  • What problem it solves
  • Why existing solutions (if any) are inadequate
  • Who would benefit from it
  • What technical challenges might need to be overcome

Make the scope clear

Have a succinct description of what your proposed tool or feature would do. Make sure your proposal has a clear scope and purpose. Link to existing tools or projects that might serve as inspiration or starting points.

Pay attention to technical feasibility

Ensure your proposal is technically feasible, even if challenging. Include thoughts about potential implementation approaches, required technologies, and possible limitations.

Choose an appropriate license

Keep in mind that if you haven't selected a license, others cannot build upon your ideas. Consider using permissive licenses to encourage development.

Creative Commons licenses are perfect for this purpose. We recommend CC0 to allow maximum freedom for developers to implement these ideas.

Include contribution guidelines

People who are contributing to the wishlist should have a clear understanding of how to structure their proposals.

Stylize your proposals properly

Create a structured format for proposals that includes:

  • Problem statement
  • Proposed solution
  • Technical requirements
  • Potential challenges
  • Use cases
  • Similar existing tools (if any)

Organize proposals into categories and use diagrams or mockups when appropriate.

Be open to refinement

If you're proposing an idea, be open to suggestions and improvements from others. The best proposals often evolve through community discussion and iteration.

Status tracking

Consider using status labels to track the state of wished-for items:

  • 🌱 Concept Stage
  • 💭 Under Discussion
  • 🛠️ In Development (if someone has started working on it)
  • ✨ Partially Implemented
  • ✅ Completed (move to an Awesome list instead)