Merge pull request #116 from Khushalsarode/main

updated documentation for project

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: 🐛 Bug Report
+about: Report a bug to help us improve CabRental
+title: "[BUG]"
+labels: bug
+assignees: ''
+---
+
+**Describe the bug**
+> A clear and concise description of what the bug is.
+
+**To Reproduce**
+```
+Explain bug encounter!
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '...'
+3. Scroll down to '...'
+4. See error
+```
+
+**Expected behavior**
+> A clear and concise description of what you expected to happen.
+
+**Screenshots**
+> If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+> Add any other context about the problem here.
+
+

.github/ISSUE_TEMPLATE/documentation_update.md

@@ -0,0 +1,16 @@
+---
+name: 📝 Documentation Update
+about: Suggest improvements or additions to the documentation
+title: "[DOCS]"
+labels: documentation
+assignees: ''
+---
+
+**Describe the documentation update**
+> A clear and concise description of the documentation that needs to be updated or added.
+
+**Why is this needed?**
+> Explain why this documentation update is important.
+
+**Additional context**
+> Add any other context or screenshots about the documentation update here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: 💡 Feature Request
+about: Suggest an idea for CabRental
+title: "[FEATURE]"
+labels: enhancement
+assignees: ''
+---
+
+**Please describe your feature request related to a problem?**
+> A one liner title for feature
+
+**Describe your solution to problem**
+> A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+> A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+> Add any other context or screenshots about the feature request here.
+
+**Add Relevant Screenshot (if available)**
+> add here

.github/ISSUE_TEMPLATE/general_issue.md

@@ -0,0 +1,16 @@
+---
+name: 📚 General Issue
+about: Discuss general topics, questions, or suggestions
+title: "[GENERAL]"
+labels: question
+assignees: ''
+---
+
+**Topic**
+> A clear and concise description of the topic or question.
+
+**Details**
+> Provide more details or context about your topic or question.
+
+**Additional context**
+> Add any other context or screenshots if necessary.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+# 🚀 Pull Request
+
+## Description
+
+Please include a summary of the changes and the related issue. Provide relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of Change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation Update
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+## Screenshot of final output/video

.github/labeler.yml

@@ -0,0 +1,17 @@
+# .github/labeler.yml
+bug:
+  - "**bug**"
+  - "**fix**"
+  - "**error**"
+  - "**issue**"
+
+enhancement:
+  - "**feature**"
+  - "**enhancement**"
+  - "**add**"
+  - "**improve**"
+
+documentation:
+  - "**docs**"
+  - "**documentation**"
+  - "**readme**"

.github/workflows/labeler.yml

@@ -0,0 +1,15 @@
+# .github/workflows/labeler.yml
+name: "Labeler"
+
+on:
+  pull_request:
+    types: [opened, edited, reopened]
+
+jobs:
+  labeler:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/labeler@v4
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          configuration-path: .github/labeler.yml

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Sumit Kumar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.