From f4cde939e2475f3968062b553b192de7cbae382f Mon Sep 17 00:00:00 2001
From: Pritam-Reddy <133579190+Pritam-Reddy@users.noreply.github.com>
Date: Fri, 3 Jan 2025 15:54:54 +0530
Subject: [PATCH 1/7] Update README.md
---
README.md | 150 +++++++++++++++++++++++++++++++++++++++++++++++-------
1 file changed, 131 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
index 8938207..6bb6144 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,146 @@
-🚀 **Introducing Leetcode Journal** 🚀
+# Leetcode Journal 🚀
-I'm excited to share [Leetcode Journal](https://github.com/yashksaini-coder/Leetcode-Journal), a project designed to help developers track, organize, and review their Leetcode solutions through an intuitive interface.
+Your ultimate companion for mastering LeetCode!
-**Key Features:**
+Leetcode Journal is a robust platform designed to help developers track, organize, and analyze their problem-solving journey on LeetCode. Whether you're preparing for coding interviews or sharpening your skills, Leetcode Journal ensures an intuitive and efficient experience.
-- 📝 **Save Solutions:** Easily store your Leetcode solutions for future reference.
-- 🗂️ **Categorize Problems:** Organize problems by categories to streamline your study sessions.
-- 📈 **Monitor Progress:** Keep track of your problem-solving journey over time.
-- 📊 **Analyze Performance:** Gain insights into your strengths and areas for improvement.
+## Table of Contents
-**Why Contribute?**
+- [Project Overview](#project-overview)
+- [Key Features](#key-features)
+- [Tech Stack](#tech-stack)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
-Leetcode Journal serves as both a personal learning tool and a showcase of problem-solving skills. By contributing, you can:
+## Project Overview
-- 🤝 **Collaborate:** Work with a community of like-minded developers.
-- 💡 **Innovate:** Bring new ideas to enhance the tool's functionality.
-- 🌟 **Grow:** Develop your skills and enrich your open-source portfolio.
+Leetcode Journal is built to address the need for systematic tracking and review of LeetCode solutions. This platform is perfect for developers who want to:
+- Save and organize their solutions.
+- Monitor progress over time.
+- Analyze performance and identify improvement areas.
+With features like advanced categorization and visual analytics, the platform aims to streamline the learning process for coders of all levels.
-**Get Started:**
+## Key Features
-1. **Explore the Repository:** Check out the project on GitHub: [Leetcode Journal](https://github.com/yashksaini-coder/Leetcode-Journal).
-2. **Read the Documentation:** Understand the project's structure and guidelines.
-3. **Contribute:** Pick an issue or suggest improvements. Your input is invaluable!
+Leetcode Journal offers the following key features:
-Let's build something amazing together! 🌐
+- **📝 Save Solutions:** Store and retrieve your LeetCode solutions effortlessly.
+- **🗂️ Categorize Problems:** Tag problems by difficulty, topic, or category for better organization.
+- **📈 Track Progress:** Visualize your journey with detailed progress tracking.
+- **📊 Performance Analytics:** Leverage charts and insights to discover patterns in your performance.
-Happy coding! 💻
+## Tech Stack
+
+Leetcode Journal leverages cutting-edge technologies to deliver a seamless user experience:
+
+- **Frontend:** React.js with external UI libraries for modern, responsive design.
+- **State Management:** Context API or Redux for efficient data handling.
+- **Backend:** Django 3.0 for scalable and secure APIs.
+- **Database:** PostgreSQL for reliable and structured data storage.
+- **Visualization:** Chart.js for interactive data insights and progress monitoring.
+- **Hosting:** Vercel for a fast, optimized live application experience.
+
+## Installation
+
+### Prerequisites
+
+Ensure you have the following tools installed:
+
+- [Node.js](https://nodejs.org/) (v16.x or higher)
+- [npm](https://www.npmjs.com/) (v6.x or higher) or yarn (v1.x or higher)
+- [Python](https://www.python.org/) (v3.x or higher)
+- [PostgreSQL](https://www.postgresql.org/) (v14.x or higher)
+ Python 3.x
+ PostgreSQL
+
+### Setup
+
+#### 1. Clone the Repository
+```bash
+git clone https://github.com/your-username/leetcode-journal.git
+
+# Navigate to the project directory
+cd leetcode-journal
+```
+
+#### 2. Install Dependencies
+```bash
+# Install backend dependencies
+pip install -r requirements.txt
+
+# Install frontend dependencies
+cd client
+npm install
+```
+#### 3. Set Up Database
+
+- Configure your PostgreSQL database in the backend settings.
+
+#### 4. Start the Application
+```bash
+# Start the backend
+python manage.py runserver
+
+# Start the frontend
+cd client
+npm start
+```
+#### 5. Open the app in your browser
+You should now be able to access the application at [http://localhost:3000](http://localhost:3000)
+
+## Usage
+
+- **Login/Sign Up:** Access your personalized dashboard.
+- **Save Solutions:** Add your solutions and tag them by category.
+- **Analyze Performance:** Explore your progress using charts and statistics.
+- **Categorize Problems:** Organize and retrieve problems effortlessly.
+
+## Contributing
+
+We welcome contributions! Follow these steps to get started:
+```bash
+# Click the "Fork" button at the top-right of the repository page to create a copy in your GitHub account.
+```
+```bash
+# Clone the forked repository to your local machine
+git clone https://github.com/your-username/leetcode-journal.git
+```
+```bash
+# Navigate into the project directory
+cd leetcode-journal
+```
+```bash
+#install dependencies
+npm install
+```
+```bash
+# Create a new branch for your feature or fix
+git checkout -b feature/your-feature-name
+```
+```bash
+# Make Your Changes
+Make sure your changes adhere to the project standards and structure.
+# Stage all changes
+git add .
+```
+```bash
+# Commit the changes with a descriptive message
+git commit -m "Description of the feature or fix"
+```
+```bash
+# Push your branch to your forked repository
+git push origin feature/your-feature-name
+```
+```bash
+# Go to the original repository on GitHub and open a new Pull Request
+# Provide a clear description of your changes in the Pull Request.
+```
*Connect with me on GitHub: [yashksaini-coder](https://github.com/yashksaini-coder)*
*Explore the live application: [Leetcode Journal Live](https://leetcode-journal.vercel.app/)*
-*Learn more about effective Leetcode practices: [The DEFINITIVE way on how to LeetCode properly](https://www.reddit.com/r/cscareerquestions/comments/sgktuv/the_definitive_way_on_how_to_leetcode_properly/)*
\ No newline at end of file
+*Learn more about effective Leetcode practices: [The DEFINITIVE way on how to LeetCode properly](https://www.reddit.com/r/cscareerquestions/comments/sgktuv/the_definitive_way_on_how_to_leetcode_properly/)*
+
+ Happy Coding ☕️
From e62463e55178bfce6360911b6c81f9cbbabbc566 Mon Sep 17 00:00:00 2001
From: Pritam-Reddy <133579190+Pritam-Reddy@users.noreply.github.com>
Date: Sat, 4 Jan 2025 19:38:04 +0530
Subject: [PATCH 2/7] Update auto-comment workflow for PRs and Issues
---
.github/workflows/autoComment.yaml | 69 ++++++++++++++++++++++++------
1 file changed, 55 insertions(+), 14 deletions(-)
diff --git a/.github/workflows/autoComment.yaml b/.github/workflows/autoComment.yaml
index 6d6ce99..66b0c82 100644
--- a/.github/workflows/autoComment.yaml
+++ b/.github/workflows/autoComment.yaml
@@ -4,7 +4,8 @@ on:
issues:
types: [opened]
pull_request:
- types: [opened]
+ types:
+ - opened
jobs:
auto-comment:
@@ -13,17 +14,57 @@ jobs:
issues: write
pull-requests: write
steps:
- - name: Auto Comment
- uses: actions/github-script@v7
+ - name: Checkout repository
+ uses: actions/checkout@v3
+
+ - name: Add Comment on Pull Request
+ if: ${{ github.event_name == 'pull_request' }}
+ uses: peter-evans/create-or-update-comment@v3
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ repository: ${{ github.repository }}
+ issue-number: ${{ github.event.pull_request.number }}
+ body: |
+ 🚀 **Hello @${{ github.event.pull_request.user.login }}!**
+
+ Thank you for your contribution to the **Leetcode Journal** project! 🎉
+ We value your effort and are excited to review your changes.
+
+ ### PR Checklist:
+ Please ensure your PR adheres to the following checklist:
+ - [ ] PR description includes a summary and context for the changes.
+ - [ ] Relevant dependencies have been listed.
+ - [ ] Testing section is filled out with details on verification.
+ - [ ] Screenshots/Videos are attached (if applicable).
+ - [ ] Checklist items are marked as completed.
+
+ ### Review Notifications:
+ - **Project Admin:** @yashksaini-coder
+ - **Mentor:** @ompharate
+
+ The team will review your PR shortly. If you have any questions, feel free to ask here!
+ Happy Coding! 🚀
+
+ - name: Add Comment on Issue
+ if: ${{ github.event_name == 'issues' }}
+ uses: peter-evans/create-or-update-comment@v3
with:
- github-token: ${{secrets.GITHUB_TOKEN}}
- script: |
- const issueComment = context.payload.issue
- ? `Thank you for opening an issue, @${context.payload.issue.user.login}! will review it soon. Meanwhile you can describe & share your approach on how to resolve this issue.`
- : `Thank you for creating this pull request, @${context.payload.pull_request.user.login}! A reviewer will check it shortly.`;
- github.rest.issues.createComment({
- owner: context.repo.owner,
- repo: context.repo.repo,
- issue_number: context.issue.number,
- body: issueComment,
- });
+ token: ${{ secrets.GITHUB_TOKEN }}
+ repository: ${{ github.repository }}
+ issue-number: ${{ github.event.issue.number }}
+ body: |
+ 👋 **Hello @${{ github.event.issue.user.login }}!**
+
+ Thank you for raising an issue in the **Leetcode Journal** project!
+ Your issue has been logged, and the team will review it shortly.
+
+ ### Issue Handling Checklist:
+ - [ ] Make sure the issue includes clear steps to reproduce (if applicable).
+ - [ ] Provide relevant context, screenshots, or logs.
+ - [ ] Mention if this issue blocks any critical workflows.
+
+ ### Notifications:
+ - **Project Admin:** @yashksaini-coder
+ - **Mentor:** @ompharate
+
+ We'll get back to you soon. Stay tuned! 🚀
\ No newline at end of file
From 6a73e4ae6bbe55c4405caa8155f16139a11f5da3 Mon Sep 17 00:00:00 2001
From: Pritam-Reddy <133579190+Pritam-Reddy@users.noreply.github.com>
Date: Sat, 4 Jan 2025 20:21:43 +0530
Subject: [PATCH 3/7] Update autoComment.yaml
---
.github/workflows/autoComment.yaml | 63 ++++++++++++++++++++++++------
1 file changed, 50 insertions(+), 13 deletions(-)
diff --git a/.github/workflows/autoComment.yaml b/.github/workflows/autoComment.yaml
index 66b0c82..e6aa51d 100644
--- a/.github/workflows/autoComment.yaml
+++ b/.github/workflows/autoComment.yaml
@@ -19,17 +19,24 @@ jobs:
- name: Add Comment on Pull Request
if: ${{ github.event_name == 'pull_request' }}
- uses: peter-evans/create-or-update-comment@v3
+ uses: actions/github-script@v6
with:
- token: ${{ secrets.GITHUB_TOKEN }}
- repository: ${{ github.repository }}
- issue-number: ${{ github.event.pull_request.number }}
- body: |
- 🚀 **Hello @${{ github.event.pull_request.user.login }}!**
+ github-token: ${{ secrets.GITHUB_TOKEN }}
+ script: |
+ const issueNumber = context.issue.number;
+ const contributor = context.issue.pull_request.user.login;
+ const relatedIssue = context.issue.pull_request.issue.number;
+
+ const commentBody = `🚀 **Hello @${contributor}!**
Thank you for your contribution to the **Leetcode Journal** project! 🎉
We value your effort and are excited to review your changes.
+ **PR Details:**
+
+ * **Contributor:** @${contributor}
+ * **Related Issue:** Closes #${relatedIssue} (if applicable)
+
### PR Checklist:
Please ensure your PR adheres to the following checklist:
- [ ] PR description includes a summary and context for the changes.
@@ -45,26 +52,56 @@ jobs:
The team will review your PR shortly. If you have any questions, feel free to ask here!
Happy Coding! 🚀
+ const params = {
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ issue_number: issueNumber,
+ body: commentBody
+ };
+
+ github.rest.issues.createComment(params);
+
- name: Add Comment on Issue
if: ${{ github.event_name == 'issues' }}
- uses: peter-evans/create-or-update-comment@v3
+ uses: actions/github-script@v6
with:
- token: ${{ secrets.GITHUB_TOKEN }}
- repository: ${{ github.repository }}
- issue-number: ${{ github.event.issue.number }}
- body: |
- 👋 **Hello @${{ github.event.issue.user.login }}!**
+ github-token: ${{ secrets.GITHUB_TOKEN }}
+ script: |
+ const issueNumber = context.issue.number;
+ const contributor = context.issue.user.login;
+ const commentBody = `👋 **Hello @${contributor}!**
+
Thank you for raising an issue in the **Leetcode Journal** project!
Your issue has been logged, and the team will review it shortly.
+ **Issue Details:**
+
+ * **Contributor:** @${contributor}
+
### Issue Handling Checklist:
- [ ] Make sure the issue includes clear steps to reproduce (if applicable).
- [ ] Provide relevant context, screenshots, or logs.
- [ ] Mention if this issue blocks any critical workflows.
+ - [ ] **If it's a Feature Request:**
+ * Explain the desired functionality, including:
+ * Approach: How you envision implementing this feature.
+ * Benefits: How this feature will improve the project.
+ - [ ] **If it's a Bug:**
+ * Describe how to resolve it without affecting the working of the project.
+
### Notifications:
- **Project Admin:** @yashksaini-coder
- **Mentor:** @ompharate
- We'll get back to you soon. Stay tuned! 🚀
\ No newline at end of file
+ We'll get back to you soon. Stay tuned! 🚀
+
+ const params = {
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ issue_number: issueNumber,
+ body: commentBody
+ };
+
+ github.rest.issues.createComment(params);
From ca7b23d81c03710cbfea9a1a3c0c573a9212122e Mon Sep 17 00:00:00 2001
From: Pritam-Reddy <133579190+Pritam-Reddy@users.noreply.github.com>
Date: Sun, 5 Jan 2025 10:25:00 +0530
Subject: [PATCH 4/7] Update autoComment.yaml
---
.github/workflows/autoComment.yaml | 66 ++++++++++++++++++++++++------
1 file changed, 53 insertions(+), 13 deletions(-)
diff --git a/.github/workflows/autoComment.yaml b/.github/workflows/autoComment.yaml
index 3b9df0c..66b0c82 100644
--- a/.github/workflows/autoComment.yaml
+++ b/.github/workflows/autoComment.yaml
@@ -14,17 +14,57 @@ jobs:
issues: write
pull-requests: write
steps:
- - name: Auto Comment
- uses: actions/github-script@v7
+ - name: Checkout repository
+ uses: actions/checkout@v3
+
+ - name: Add Comment on Pull Request
+ if: ${{ github.event_name == 'pull_request' }}
+ uses: peter-evans/create-or-update-comment@v3
with:
- github-token: ${{secrets.GITHUB_TOKEN}}
- script: |
- const issueComment = context.payload.issue
- ? `Thank you for opening an issue, @${context.payload.issue.user.login}! will review it soon. Meanwhile you can describe & share your approach on how to resolve this issue.`
- : `Thank you for creating this pull request, @${context.payload.pull_request.user.login}! A reviewer will check it shortly.`;
- github.rest.issues.createComment({
- owner: context.repo.owner,
- repo: context.repo.repo,
- issue_number: context.issue.number,
- body: issueComment,
- });
+ token: ${{ secrets.GITHUB_TOKEN }}
+ repository: ${{ github.repository }}
+ issue-number: ${{ github.event.pull_request.number }}
+ body: |
+ 🚀 **Hello @${{ github.event.pull_request.user.login }}!**
+
+ Thank you for your contribution to the **Leetcode Journal** project! 🎉
+ We value your effort and are excited to review your changes.
+
+ ### PR Checklist:
+ Please ensure your PR adheres to the following checklist:
+ - [ ] PR description includes a summary and context for the changes.
+ - [ ] Relevant dependencies have been listed.
+ - [ ] Testing section is filled out with details on verification.
+ - [ ] Screenshots/Videos are attached (if applicable).
+ - [ ] Checklist items are marked as completed.
+
+ ### Review Notifications:
+ - **Project Admin:** @yashksaini-coder
+ - **Mentor:** @ompharate
+
+ The team will review your PR shortly. If you have any questions, feel free to ask here!
+ Happy Coding! 🚀
+
+ - name: Add Comment on Issue
+ if: ${{ github.event_name == 'issues' }}
+ uses: peter-evans/create-or-update-comment@v3
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ repository: ${{ github.repository }}
+ issue-number: ${{ github.event.issue.number }}
+ body: |
+ 👋 **Hello @${{ github.event.issue.user.login }}!**
+
+ Thank you for raising an issue in the **Leetcode Journal** project!
+ Your issue has been logged, and the team will review it shortly.
+
+ ### Issue Handling Checklist:
+ - [ ] Make sure the issue includes clear steps to reproduce (if applicable).
+ - [ ] Provide relevant context, screenshots, or logs.
+ - [ ] Mention if this issue blocks any critical workflows.
+
+ ### Notifications:
+ - **Project Admin:** @yashksaini-coder
+ - **Mentor:** @ompharate
+
+ We'll get back to you soon. Stay tuned! 🚀
\ No newline at end of file
From 50435441e1dbc35cf5c73958661b2f3282d34bef Mon Sep 17 00:00:00 2001
From: Pritam-Reddy <133579190+Pritam-Reddy@users.noreply.github.com>
Date: Sun, 5 Jan 2025 10:59:07 +0530
Subject: [PATCH 5/7] added ISSUES Template
---
.github/ISSUE_TEMPLATE/Bug-report.yaml | 32 ++++++++++
.github/ISSUE_TEMPLATE/Doc-Update.yaml | 67 +++++++++++++++++++
.github/ISSUE_TEMPLATE/Feature-Request.yaml | 71 +++++++++++++++++++++
.github/ISSUE_TEMPLATE/General_issue.yaml | 67 +++++++++++++++++++
4 files changed, 237 insertions(+)
create mode 100644 .github/ISSUE_TEMPLATE/Bug-report.yaml
create mode 100644 .github/ISSUE_TEMPLATE/Doc-Update.yaml
create mode 100644 .github/ISSUE_TEMPLATE/Feature-Request.yaml
create mode 100644 .github/ISSUE_TEMPLATE/General_issue.yaml
diff --git a/.github/ISSUE_TEMPLATE/Bug-report.yaml b/.github/ISSUE_TEMPLATE/Bug-report.yaml
new file mode 100644
index 0000000..a3ff5b5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/Bug-report.yaml
@@ -0,0 +1,32 @@
+name: 🐞 Bug
+description: Report an issue to help us improve the project.
+title: "[BUG] "
+labels: ["bug", "goal: fix", "priority: medium"]
+body:
+ - type: textarea
+ attributes:
+ label: Description
+ description: A brief description of the issue or bug you are facing, also include what you tried and what didn't work.
+ validations:
+ required: false
+ - type: textarea
+ attributes:
+ label: Screenshots
+ description: Please add screenshots if applicable
+ validations:
+ required: false
+ - type: textarea
+ attributes:
+ label: Any additional information?
+ description: Any additional information or Is there anything we should know about this bug?
+ validations:
+ required: false
+ - type: dropdown
+ attributes:
+ label: What browser are you seeing the problem on?
+ multiple: true
+ options:
+ - Firefox
+ - Chrome
+ - Safari
+ - Microsoft Edge
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/Doc-Update.yaml b/.github/ISSUE_TEMPLATE/Doc-Update.yaml
new file mode 100644
index 0000000..6078ede
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/Doc-Update.yaml
@@ -0,0 +1,67 @@
+name: "📚 Documentation Update"
+description: "Help us improve our documentation"
+title: "[DOCS] "
+labels: ["documentation"]
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for helping improve our documentation! 📖
+ Please fill out the information below to help us understand your suggestion better.
+
+ - type: textarea
+ id: current_docs
+ attributes:
+ label: "Current Documentation"
+ description: "What's currently in the documentation that needs to be updated?"
+ placeholder: "Example: The installation guide is missing steps for Windows setup..."
+ validations:
+ required: true
+
+ - type: textarea
+ id: suggested_change
+ attributes:
+ label: "Suggested Changes"
+ description: "What changes would you like to see?"
+ placeholder: "Example: Add Windows-specific installation steps..."
+ validations:
+ required: true
+
+ - type: textarea
+ id: screenshots
+ attributes:
+ label: "Screenshots or Examples"
+ description: "Add screenshots or examples if applicable"
+ placeholder: "Drag and drop images here..."
+
+ - type: dropdown
+ id: doc_type
+ attributes:
+ label: "Documentation Type"
+ options:
+ - Installation Guide
+ - API Reference
+ - Tutorials
+ - README
+ - Other
+ validations:
+ required: true
+
+ - type: checkboxes
+ id: terms
+ attributes:
+ label: "Contribution Agreement"
+ options:
+ - label: "I have searched existing issues and this is not a duplicate"
+ required: true
+ - label: "I have read the contributing guidelines"
+ required: true
+ - label: "I would like to work on fixing this documentation"
+ required: false
+
+ - type: markdown
+ attributes:
+ value: |
+ ---
+ ⭐ Thank you for helping make our documentation better!
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/Feature-Request.yaml b/.github/ISSUE_TEMPLATE/Feature-Request.yaml
new file mode 100644
index 0000000..d18653d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/Feature-Request.yaml
@@ -0,0 +1,71 @@
+name: "✨ Feature Request"
+description: "Suggest a new feature to enhance our Leetcode-Journal"
+title: "[FEATURE] "
+labels: ["enhancement"]
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ # Feature Request
+ Thanks for taking the time to suggest a new feature!
+ Please fill out the information below to help us understand your suggestion better.
+
+ - type: textarea
+ id: problem
+ attributes:
+ label: "Problem Statement"
+ description: "What problem does this feature solve?"
+ placeholder: "I'm always frustrated when..."
+ validations:
+ required: true
+
+ - type: textarea
+ id: solution
+ attributes:
+ label: "Proposed Solution"
+ description: "Describe the solution you'd like"
+ placeholder: "It would be great if..."
+ validations:
+ required: true
+
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: "Alternative Solutions"
+ description: "What alternatives have you considered?"
+ placeholder: "Another approach could be..."
+
+ - type: textarea
+ id: screenshots
+ attributes:
+ label: "Screenshots or Mockups"
+ description: "Add any relevant screenshots, mockups or examples"
+ placeholder: "Drag and drop images here..."
+
+ - type: dropdown
+ id: priority
+ attributes:
+ label: "Priority"
+ options:
+ - High
+ - Medium
+ - Low
+ validations:
+ required: true
+
+ - type: checkboxes
+ id: terms
+ attributes:
+ label: "Contribution Guidelines"
+ options:
+ - label: "I have searched [existing issues](https://github.com/yashksaini-coder/Leetcode-Journal/issues) and this is not a duplicate"
+ required: true
+ - label: "I would like to implement this feature"
+ required: false
+
+ - type: markdown
+ attributes:
+ value: |
+ ---
+ 💡 Thank you for contributing to make our Leetcode Journal better!
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/General_issue.yaml b/.github/ISSUE_TEMPLATE/General_issue.yaml
new file mode 100644
index 0000000..73b8ab9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/General_issue.yaml
@@ -0,0 +1,67 @@
+name: "🤔 General Issue"
+description: "Submit a general question, suggestion or issue"
+title: "[GENERAL] "
+labels: ["triage-needed"]
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ # General Issue Template
+ Thanks for taking the time to fill out this issue! Please provide as much information as possible.
+
+ - type: dropdown
+ id: category
+ attributes:
+ label: "Category"
+ description: "What type of issue is this?"
+ options:
+ - Question
+ - Suggestion
+ - Problem
+ - Other
+ validations:
+ required: true
+
+ - type: textarea
+ id: description
+ attributes:
+ label: "Description"
+ description: "What would you like to share or ask?"
+ placeholder: "Provide details about your issue, question, or suggestion..."
+ validations:
+ required: true
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: "Additional Context"
+ description: "Add any other context, screenshots, or relevant information"
+ placeholder: "Add any additional details here..."
+
+ - type: dropdown
+ id: impact
+ attributes:
+ label: "Impact Level"
+ options:
+ - High
+ - Medium
+ - Low
+ validations:
+ required: true
+
+ - type: checkboxes
+ id: terms
+ attributes:
+ label: "Contribution Guidelines"
+ options:
+ - label: "I have searched [existing issues](https://github.com/yashksaini-coder/Leetcode-Journal/issues) to avoid duplicates"
+ required: true
+ - label: "I would like to help resolve this issue"
+ required: false
+
+ - type: markdown
+ attributes:
+ value: |
+ ---
+ Thank you for contributing to our project! 🙏
\ No newline at end of file
From 6d066c45d462c26aee19d8bd68b5e07ba6798ad0 Mon Sep 17 00:00:00 2001
From: Pritam-Reddy <133579190+Pritam-Reddy@users.noreply.github.com>
Date: Sun, 5 Jan 2025 11:30:58 +0530
Subject: [PATCH 6/7] Created PR Template
---
.github/Pull_request_Template.md | 32 ++++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
create mode 100644 .github/Pull_request_Template.md
diff --git a/.github/Pull_request_Template.md b/.github/Pull_request_Template.md
new file mode 100644
index 0000000..52cbf96
--- /dev/null
+++ b/.github/Pull_request_Template.md
@@ -0,0 +1,32 @@
+# Pull Request Template
+
+## Summary
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of Change
+Please mark [X] for applicable items:
+
+- [ ] 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
+- [ ] Code refactoring
+- [ ] Other (please describe):
+
+## Testing
+Please describe the tests you performed to verify your changes:
+
+## Screenshots/Videos
+Please attach relevant screenshots or videos demonstrating the changes.
+
+## Checklist
+Please mark [X] for completed items:
+
+- [ ] My code follows the project's style guidelines
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have updated the documentation accordingly
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
From ce543572d26b6deffc4474e85d4144ac97ea8246 Mon Sep 17 00:00:00 2001
From: Pritam-Reddy <133579190+Pritam-Reddy@users.noreply.github.com>
Date: Sun, 5 Jan 2025 12:30:23 +0530
Subject: [PATCH 7/7] Delete Doc-Update.yaml
---
.github/ISSUE_TEMPLATE/Doc-Update.yaml | 67 --------------------------
1 file changed, 67 deletions(-)
delete mode 100644 .github/ISSUE_TEMPLATE/Doc-Update.yaml
diff --git a/.github/ISSUE_TEMPLATE/Doc-Update.yaml b/.github/ISSUE_TEMPLATE/Doc-Update.yaml
deleted file mode 100644
index 6078ede..0000000
--- a/.github/ISSUE_TEMPLATE/Doc-Update.yaml
+++ /dev/null
@@ -1,67 +0,0 @@
-name: "📚 Documentation Update"
-description: "Help us improve our documentation"
-title: "[DOCS] "
-labels: ["documentation"]
-
-body:
- - type: markdown
- attributes:
- value: |
- Thanks for helping improve our documentation! 📖
- Please fill out the information below to help us understand your suggestion better.
-
- - type: textarea
- id: current_docs
- attributes:
- label: "Current Documentation"
- description: "What's currently in the documentation that needs to be updated?"
- placeholder: "Example: The installation guide is missing steps for Windows setup..."
- validations:
- required: true
-
- - type: textarea
- id: suggested_change
- attributes:
- label: "Suggested Changes"
- description: "What changes would you like to see?"
- placeholder: "Example: Add Windows-specific installation steps..."
- validations:
- required: true
-
- - type: textarea
- id: screenshots
- attributes:
- label: "Screenshots or Examples"
- description: "Add screenshots or examples if applicable"
- placeholder: "Drag and drop images here..."
-
- - type: dropdown
- id: doc_type
- attributes:
- label: "Documentation Type"
- options:
- - Installation Guide
- - API Reference
- - Tutorials
- - README
- - Other
- validations:
- required: true
-
- - type: checkboxes
- id: terms
- attributes:
- label: "Contribution Agreement"
- options:
- - label: "I have searched existing issues and this is not a duplicate"
- required: true
- - label: "I have read the contributing guidelines"
- required: true
- - label: "I would like to work on fixing this documentation"
- required: false
-
- - type: markdown
- attributes:
- value: |
- ---
- ⭐ Thank you for helping make our documentation better!
\ No newline at end of file