added contribution instructions and issue template for better collaboration

CONTRIBUTION.md

@@ -0,0 +1,36 @@
+# Contributing to The Project
+
+We welcome contributions from everyone. To make the process as smooth as possible, please follow the guidelines below. 
+
+## How to Contribute
+
+### Code Contributions
+
+1. **Creating a Branch**: For any code contribution, start by creating a branch from the main project. The branch should be named using the pattern `#issue-id short-name-to-describe-what-is-added`. This helps in linking the contributions directly to the issues they are meant to resolve.
+
+2. **Pull Requests**: Once you've made your changes, create a pull request (PR). Please fill out the pull request template with all the required information. This includes a summary of your changes and why they are necessary.
+
+3. **Review Process**: Every code contribution requires a review. A minimum of one maintainer must review and approve your contribution before it can be merged. This ensures quality and adherence to the project's standards. Please ensure your code is well-documented through comments and, if necessary, additional documentation files.
+
+4. **Testing**: Your code must be tested to ensure it works as expected and does not introduce new issues.
+
+### Reporting Issues
+
+When reporting issues, please use the provided issue template. Your report should include:
+
+- A clear, descriptive title
+- A detailed description of the issue
+- Steps to reproduce the issue
+- Logs, if applicable
+- Screenshots, if applicable
+
+This information is crucial in diagnosing and fixing the issue you're experiencing.
+
+### Suggestions
+
+We're always looking for new ideas to improve our project. If you have a suggestion, please:
+
+- Clearly describe your suggestion, including the purpose and intended outcome.
+- Explain why you believe this change would be beneficial to the project.
+
+We appreciate your contributions and look forward to collaborating with you!

.github/issue_template.md

@@ -0,0 +1,34 @@
+# Issue Template for LLM + RAG Applications
+
+## Description
+Please provide a clear and concise description of the issue. Include what you expected to happen versus what actually happened. If the issue is related to retrieval results or generative outputs, specify the discrepancies.
+
+## Steps to Reproduce
+1. Detail the exact steps to reproduce the problem. Include any specific inputs given to the system.
+2. 
+3. 
+(Continue as needed)
+
+## Expected vs. Actual Results
+- **Expected Results**: Describe what you expected to happen.
+- **Actual Results**: Detail what actually happened, including any unexpected outputs or errors.
+
+## Environment
+- Application version:
+- LLM model version:
+- RAG component (if applicable):
+- OS:
+- Additional tools/libraries:
+
+## Query or Input Details
+- **Input Query/Text**: Provide the exact text or input given to the system.
+- **Retrieval Source(s)**: Specify the datasets or sources queried by the RAG component, if relevant.
+
+## Logs and Error Messages
+Please include any relevant logs, error messages, or stack traces that could help diagnose the issue.
+
+## Screenshots
+If applicable, add screenshots to help explain the issue, especially if it involves UI elements.
+
+## Additional Context
+Add any other context about the problem here, such as specific configurations of the LLM or RAG components that might be relevant.