Project Direction & Contribution Guidelines

[othneildrew]

First off, thank you to everyone who has contributed so far. Every suggestion and PR helps shape this project, and I’ll continue reviewing each one with the goal of improving the template while keeping it simple.

This repository is intentionally kept minimal. Its purpose is to provide solid README templates, not to serve as an all-in-one workflow hub. For that reason, I’d like to set clear expectations about contributions and the future of the project.

---

Project Direction

• Keep it lean: The main repo will stay lightweight, focused only on README templates.
• Reduce PR clutter: To avoid many small PRs for highly technical workflows, I’ll centralize those conversations in a GitHub Discussion thread (this one). That way, we can brainstorm ideas without bloating the repo.
• Future ideas:
  • A GUI-based editor (website) where you can choose what sections you want, or even upload a package.json to pre-fill relevant parts of your README.
  • A potential IDE plugin (VSCode most likely, though I personally use WebStorm).
  • I'm also cooking-up an all-in-one developer frontend developer focused tool. It's goal is to be extensible and be able to write plugins to get whatever functionality you want (what a basic todo list? an image color extractor? base64 encoder? maybe a place to store private code snippets? Yes, yes and yes! It'll handle that and much more)

---

Contribution Guidelines

• PRs welcome: Contributions that improve readability, clarity, and template usability are appreciated.
• Not expected: PRs that add complex workflows, heavy automation, or highly opinionated configs won’t be merged here. Bring those ideas to this discussion instead.
• Licensing: No license notice is required to use this repo. If you’d like to give credit, a link back in your acknowledgments is always appreciated: [Best-README-Template](https://github.com/othneildrew/Best-README-Template)

---

Let’s Collaborate

I’d love to hear your thoughts on where this project should go. Which direction gives the best developer experience (DevEx)? What features would you like to see in the future spin-off projects?

---

Drop your suggestions below and let’s build something awesome together 🚀

[othneildrew]

Multi-language support seems to be the most common request right now, this will be added next.