-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
👋 Welcome! This is a beginner-friendly issue for anyone who wants to make their first contribution to xsql.
Problem
The project currently lacks a clear README that explains:
- What xsql is
- What problem it solves
- How to run or use it
- A small usage example
This makes it harder for new users (and contributors) to get started.
What needs to be done
- Create or improve
README.md - Include:
- Short project description (2–3 sentences)
- Installation steps
- Basic usage example
- Project goals / roadmap (optional)
Requirements
- Clear and simple language
- No deep Rust knowledge required
- Code examples should compile (if applicable)
Helpful pointers
- Look at READMEs from similar projects
- Keep it minimal and beginner-friendly
How to submit
- Fork the repo
- Create a new branch
- Make your changes
- Open a PR referencing this issue
If you have questions, feel free to ask in the comments 🙌
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed