Merge pull request #16 from SeaseLtd/dage-143_contribution

DAGE-143: Add CONTRIBUTING.md file

Author: nseidan

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to LLM Search Quality Evaluation
+
+First of all, thank you for considering contributing to the **LLM Search Quality Evaluation** project.
+
+
+We welcome contributions from everyone. By participating in this project, you help us improve search quality evaluation standards for the community.
+
+## Overview
+
+* [How to Contribute](#how-to-contribute)
+* [Existing Issues](#existing-issues)
+* [Development Setup](#development-setup)
+* [Pull Request Process](#pull-request-process)
+* [Reporting Issues](#reporting-issues)
+
+----------
+
+
+## How to Contribute
+
+There are several ways you can help:
+
+* **Report Issues:** If you find a bug/issue, please create a [github issue](https://github.com/SeaseLtd/llm-search-quality-evaluation/issues).
+* **Suggest Features:** Have an idea for a new metric or evaluation method? Open an issue to discuss it.
+* **Contribute To Existing Issues:** Tackle [open github issues](https://github.com/SeaseLtd/llm-search-quality-evaluation/issues)  or submit new features.
+
+## Existing Issues
+
+We have a list of open issues that we need help with. This is the best place to start if you are looking for code contributions.
+
+* **[View Open Issues](https://github.com/SeaseLtd/llm-search-quality-evaluation/issues)**
+
+If you find an issue you would like to work on, please comment on it and so that to avoid duplicating work.
+
+## Development Setup
+
+To get started with the project, please follow the installation and setup instructions provided in our main documentation.
+Either you could go to the LLM search quality evaluation tutorial for detailed setup or just the LLM search quality evaluation README. 
+* [LLM Search Quality Evaluation Tutorial README](https://github.com/SeaseLtd/llm-search-quality-evaluation-tutorial/blob/main/README.md)
+* [LLM Search Quality Evaluation README](https://github.com/SeaseLtd/llm-search-quality-evaluation/blob/main/README.md)
+
+Please make sure you can run the project locally before making changes.
+
+## Pull Request Process
+
+We use the standard GitHub "Fork & Pull" workflow.
+Fork our repo and once you have changes, commit them to your fork, then create a Pull Request (PR) to our repo.
+
+Before submitting a PR, please ensure:
+* [ ] Add unit test(s) and make sure you run all tests and they do pass.
+* [ ] If you added a new feature, update the README or relevant documentation.
+* [ ] Run `mypy` and `ruff` for type checking and finding issues/formatting.
+
+## Reporting Issues
+
+This section guides you through submitting a bug report.
+
+When opening a new issue, please include:
+1.  **A clear title.** Descriptive, self-explanatory title
+2.  **Description:** What the issue is about ?
+3.  **Suggested approach:** (Optional) Any suggested idea to solve the problem if you have. 
+
+
+**Questions?**
+If you have any questions, feel free to open a discussion in the Issues tab.
+
+
+