|
| 1 | +# Lingo.dev Community Contributions |
| 2 | + |
| 3 | +Welcome to the official community space of Lingo.dev! |
| 4 | + |
| 5 | +This directory is a dedicated space for community-driven projects, demo applications, and integrations that showcase what can be built with Lingo.dev. |
| 6 | + |
| 7 | +**Note:** The code in this directory is for examples and educational purposes. It exists separately from the core Lingo.dev product source code. If you want to contribute to the core product (like the CLI, compiler etc), you can go through our or open new one. |
| 8 | + |
| 9 | +## 📂 What belongs here? |
| 10 | + |
| 11 | +We encourage you to submit projects that help others learn and build. Ideal contributions include: |
| 12 | + |
| 13 | +* **Demo Apps:** Full-stack or frontend applications (e.g., React, Next.js) demonstrating specific Lingo.dev features. |
| 14 | +* **Integrations:** Scripts or plugins that connect Lingo.dev with other tools in your stack. |
| 15 | +* **Starters/Boilerplates:** Minimal setups to help new users get up and running quickly. |
| 16 | +* **Tutorial Code:** Source code companion files for blogs or video tutorials. |
| 17 | + |
| 18 | +## 🚀 How to Contribute |
| 19 | + |
| 20 | +We love seeing what you build! To contribute to this directory: |
| 21 | + |
| 22 | +1. **Fork & Branch:** Fork the repository and create a new branch for your contribution. |
| 23 | +2. **Create a Directory:** Inside `community/`, create a new folder for your project. Please use `kebab-case` for naming (e.g., `community/react-todo-demo`). |
| 24 | +3. **Add Documentation:** Every contribution **must** have its own `README.md` inside its folder explaining: |
| 25 | + * What the project does. |
| 26 | + * Prerequisites (e.g., Node version, API keys). |
| 27 | + * How to run it locally. |
| 28 | +4. **Submit a PR:** Open a Pull Request targeting the `main` branch. Please tag your PR with `community-submission` so our team can spot it easily. |
| 29 | +5. Don't forget to add a changeset in your PRs as mentioned in our [contributor's guide](https://github.com/lingodotdev/lingo.dev/blob/main/CONTRIBUTING.md). |
| 30 | + |
| 31 | +## 💬 Join the Discussion |
| 32 | + |
| 33 | +If you have an idea for a contribution but aren't sure where to start, or if you want to show off your work: |
| 34 | + |
| 35 | +* **Discord:** Join our [Discord server](https://lingo.dev/go/discord) to interact with our fellow community members. |
| 36 | +* **Issues:** You can also open a GitHub Issue with the tag `community-submission-idea` to discuss potential contributions. |
| 37 | + |
| 38 | +## ⚖️ License & Disclaimer |
| 39 | + |
| 40 | +Code in the `community/` directory is contributed by the community. While the Lingo.dev team reviews submissions, these projects are maintained by their respective authors. |
| 41 | + |
| 42 | +By contributing, you agree that your code will be licensed under the same terms as the repository. |
0 commit comments