CONTRIBUTING.md

Contributing to RAGloma

Thank you for your interest in contributing! :) 🎉

We welcome all kinds of contributions — bug fixes, improvements, documentation updates, and new features.

---

🧭 Getting Started

1. Fork the repository.
2. Clone your fork locally:

   git clone https://github.com/your-username/your-repo.git

3. Create a new branch for your work:

   git checkout -b feat/your-feature-name

4. Install dependencies:

   npm install

5. Run locally:

   npm run dev

🧪 Development Guidelines

I. Follow existing code style and linting rules.

II. Write clear commit messages (use Conventional Commits if possible).

III. Add or update tests when relevant.

IV. Ensure the project builds successfully before submitting:

📝 Submitting Changes

• Commit your changes:

  git add .
  git commit -m "fix: describe your fix"
  

• Push to your fork:

  git push origin feat/your-feature-name
  

• Open a Pull Request (PR) on the main repository.

🧰 Reporting Issues

1. If you find a bug or have a feature request:

2. Check if it’s already reported in the Issues tab.

3. If not, open a new issue and include:

4. A clear description of the problem or feature

---

Thank you for helping make RAGloma better! 🙌